{ "components": { "schemas": { "FrameInsertRequest": { "type": "object", "properties": { "frames": { "minItems": 1, "maxItems": 100, "description": "Frames to insert", "type": "array", "items": { "type": "object", "properties": { "meta": { "description": "Frame metadata (id mandatory)", "type": "object", "properties": { "name": { "description": "Frame display name", "type": "string", "maxLength": 500 }, "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Frame ID (mandatory, UUID)", "type": "string", "maxLength": 200 } }, "required": [ "id" ] }, "type": { "description": "Frame type discriminator", "type": "string", "maxLength": 50, "enum": [ "A4", "A3", "A5", "A6", "A7", "SLIDE_LANDSCAPE", "SLIDE_PORTRAIT", "DEVICE_PHONE", "DEVICE_TABLET", "DEVICE_DESKTOP", "DEVICE_TV", "DEVICE_WATCH", "SM_TWITTER_POST", "SM_TWITTER_HEADER", "SM_FB_POST", "SM_FB_COVER", "SM_INSTAGRAM_POST", "SM_INSTAGRAM_STORY", "SM_LINKEDIN_POST", "SM_LINKEDIN_COVER", "CUSTOM" ] }, "properties": { "description": "Frame properties", "type": "object", "properties": { "layout": { "description": "Position and size", "type": "object", "properties": { "rotate": { "description": "Rotation angle in degrees", "type": "integer" }, "top": { "description": "Top position (Y)", "type": "number" }, "left": { "description": "Left position (X)", "type": "number" }, "width": { "description": "Width in pixels", "type": "number" }, "flipv": { "description": "Flip vertical", "type": "boolean" }, "fliph": { "description": "Flip horizontal", "type": "boolean" }, "height": { "description": "Height in pixels", "type": "number" } } }, "strokes": { "maxItems": 10, "description": "Stroke layers", "type": "array", "items": { "type": "object", "properties": { "captype": { "description": "CapType enum", "type": "string", "maxLength": 20, "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "jointype": { "description": "JoinType enum", "type": "string", "maxLength": 20, "enum": [ "ROUND", "BEVEL", "MITER" ] }, "width": { "description": "Stroke width in pixels", "type": "number" }, "position": { "description": "StrokePosition enum", "type": "string", "maxLength": 20, "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "type": { "description": "StrokeType enum (UI subset: Solid/Dashed/Dotted; use fill.no_fill for 'no border')", "type": "string", "maxLength": 50, "enum": [ "SOLID", "DASH", "SQUARE_DOT" ] }, "fill": { "description": "Stroke fill (solid or no_fill; no_fill expresses 'no border')", "type": "object", "properties": { "solid": { "description": "Solid stroke fill (oneof variant)", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No stroke fill — stroke-off toggle (oneof variant)", "type": "object", "properties": {} }, "alpha": { "description": "Stroke fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } }, "fills": { "maxItems": 10, "description": "Fill layers", "type": "array", "items": { "type": "object", "properties": { "solid": { "description": "Solid fill", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No fill", "type": "object", "properties": {} }, "gradient": { "description": "Gradient fill", "type": "object", "properties": { "linear": { "description": "Geometry for LINEAR gradients", "type": "object", "properties": { "start": { "description": "Gradient axis start point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "Gradient axis end point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "start", "end" ] }, "radial_angular": { "description": "Geometry for RADIAL/ANGULAR gradients", "type": "object", "properties": { "flip_horizontal": { "description": "Mirror horizontally", "type": "boolean" }, "center": { "description": "Center point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "spread_x": { "description": "Horizontal spread (>= 0)", "type": "number" }, "spread_y": { "description": "Vertical spread (>= 0)", "type": "number" }, "rotation_angle": { "description": "Rotation in degrees", "type": "number" }, "flip_vertical": { "description": "Mirror vertically", "type": "boolean" } }, "required": [ "center" ] }, "stops": { "minItems": 2, "maxItems": 20, "description": "Gradient stops (minimum 2 required — a gradient needs from/to)", "type": "array", "items": { "type": "object", "properties": { "color": { "description": "Stop color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "position": { "description": "Stop position 0-1 (mandatory)", "type": "number" } }, "required": [ "color", "position" ] } }, "type": { "description": "GradientFillType enum (client renders LINEAR/RADIAL/ANGULAR only)", "type": "string", "maxLength": 50, "enum": [ "LINEAR", "RADIAL", "ANGULAR" ] } }, "required": [ "stops" ] }, "alpha": { "description": "Fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } } }, "required": [ "meta" ] } } }, "required": [ "frames" ] }, "GetTextPayload": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "range", "all_text" ], "name": "target" } ], "properties": { "all_text": { "type": "boolean" }, "range": { "$ref": "#/components/schemas/TextRange" } } }, "VaniEnvelope": { "description": "Standard Vani response envelope.", "type": "object", "properties": { "data": { "description": "Operation payload. Narrowed per endpoint where a response schema is declared.", "type": "object" }, "message": { "type": "string" }, "request_uri": { "type": "string" }, "status": { "description": "success or error", "type": "string" } }, "required": [ "status" ] }, "VaniError": { "description": "Standard Vani error envelope.", "type": "object", "properties": { "error": { "type": "object", "properties": { "details": { "description": "Error code and message, plus any context keys (edition_id, space_id, ...).", "additionalProperties": true, "type": "object", "properties": { "sdk_error_code": { "description": "Raw SDK code, present when the error was not mapped.", "type": "string" }, "error_code": { "type": "string" }, "message": { "type": "string" } } } } }, "request_uri": { "type": "string" }, "status": { "type": "string" } } }, "TextRange": { "type": "object", "properties": { "start_index": { "format": "int32", "type": "string" }, "end_index": { "format": "int32", "type": "string" } } }, "ConnectorInsertRequest": { "type": "object", "properties": { "elements": { "minItems": 1, "maxItems": 100, "description": "Connector elements to insert", "type": "array", "items": { "type": "object", "properties": { "connector": { "description": "Connector (mandatory for connector insert)", "type": "object", "properties": { "connected": { "description": "Connected shapes (mandatory)", "type": "object", "properties": { "first": { "description": "Start endpoint (mandatory)", "type": "object", "properties": { "side": { "description": "ConnectionSide enum", "type": "string", "maxLength": 20, "enum": [ "NORTH", "EAST", "SOUTH", "WEST" ] }, "marker": { "description": "MarkerType enum", "type": "string", "maxLength": 50, "enum": [ "NONE", "OPEN", "BLOCK", "CLASSIC", "DIAMOND", "OVAL" ] }, "shape_id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Connected shape ID (mandatory, UUID)", "type": "string", "maxLength": 200 }, "point": { "description": "Custom attach point (x, y)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "shape_id" ] }, "second": { "description": "End endpoint (mandatory)", "type": "object", "properties": { "side": { "description": "ConnectionSide enum", "type": "string", "maxLength": 20, "enum": [ "NORTH", "EAST", "SOUTH", "WEST" ] }, "marker": { "description": "MarkerType enum", "type": "string", "maxLength": 50, "enum": [ "NONE", "OPEN", "BLOCK", "CLASSIC", "DIAMOND", "OVAL" ] }, "shape_id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Connected shape ID (mandatory, UUID)", "type": "string", "maxLength": 200 }, "point": { "description": "Custom attach point (x, y)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "shape_id" ] } }, "required": [ "first", "second" ] }, "text": { "description": "Connector text", "type": "object", "properties": { "placeholder": { "description": "Placeholder binding", "type": "object", "properties": { "type": { "description": "PlaceholderType enum (mandatory when placeholder binding is present)", "type": "string", "maxLength": 50, "enum": [ "TITLE", "SUBTITLE", "CONTENT", "IMAGE", "CHART", "TABLE" ] } }, "required": [ "type" ] }, "paragraphs": { "maxItems": 1000, "description": "Paragraphs", "type": "array", "items": { "type": "object", "properties": { "style": { "description": "Paragraph style", "type": "object", "properties": { "spacing": { "description": "Paragraph spacing", "type": "object", "properties": { "before": { "description": "Spacing before paragraph", "type": "integer" }, "line": { "description": "Line spacing", "type": "number" }, "after": { "description": "Spacing after paragraph", "type": "integer" } } }, "level": { "description": "Indent level", "type": "integer" }, "portion_style": { "description": "Default portion style", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Font size", "type": "number" }, "color": { "description": "Text color", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "underline": { "description": "Underline flag", "type": "boolean" }, "strike": { "description": "Strikethrough flag", "type": "boolean" }, "italic": { "description": "Italic flag", "type": "boolean" }, "font_name": { "description": "Font name object", "type": "object", "properties": { "name": { "description": "Font family name", "type": "string", "maxLength": 200, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] }, "style": { "description": "Font style", "type": "string", "maxLength": 100 } } } } }, "halign": { "description": "HorizontalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } }, "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Paragraph identifier (mandatory, UUID)", "type": "string", "maxLength": 200 }, "portions": { "maxItems": 500, "description": "Text runs (portions)", "type": "array", "items": { "type": "object", "properties": { "style": { "description": "Portion style", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Font size", "type": "number" }, "color": { "description": "Text color", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "underline": { "description": "Underline flag", "type": "boolean" }, "strike": { "description": "Strikethrough flag", "type": "boolean" }, "italic": { "description": "Italic flag", "type": "boolean" }, "font_name": { "description": "Font name object", "type": "object", "properties": { "name": { "description": "Font family name", "type": "string", "maxLength": 200, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] }, "style": { "description": "Font style", "type": "string", "maxLength": 100 } } } } }, "text": { "description": "Text content", "type": "string", "maxLength": 100000 } } } } }, "required": [ "id" ] } }, "properties": { "description": "Text properties (valign, inset, etc.)", "type": "object", "properties": { "inset": { "description": "Text padding", "type": "object", "properties": { "top": { "description": "Top padding", "type": "number" }, "left": { "description": "Left padding", "type": "number" }, "bottom": { "description": "Bottom padding", "type": "number" }, "right": { "description": "Right padding", "type": "number" } } }, "auto_fit": { "description": "TextBoxAutoFit enum", "type": "string", "maxLength": 20, "enum": [ "NONE", "TEXT", "SHAPE" ] }, "valign": { "description": "VerticalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "MIDDLE", "TOP", "BOTTOM" ] }, "para_style": { "description": "Default paragraph style", "type": "object", "properties": { "spacing": { "description": "Paragraph spacing", "type": "object", "properties": { "before": { "description": "Spacing before paragraph", "type": "integer" }, "line": { "description": "Line spacing", "type": "number" }, "after": { "description": "Spacing after paragraph", "type": "integer" } } }, "level": { "description": "Indent level", "type": "integer" }, "portion_style": { "description": "Default portion style", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Font size", "type": "number" }, "color": { "description": "Text color", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "underline": { "description": "Underline flag", "type": "boolean" }, "strike": { "description": "Strikethrough flag", "type": "boolean" }, "italic": { "description": "Italic flag", "type": "boolean" }, "font_name": { "description": "Font name object", "type": "object", "properties": { "name": { "description": "Font family name", "type": "string", "maxLength": 200, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] }, "style": { "description": "Font style", "type": "string", "maxLength": 100 } } } } }, "halign": { "description": "HorizontalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } } } } } }, "type": { "description": "ConnectorType enum", "type": "string", "maxLength": 20, "enum": [ "LINE", "ELBOW", "CURVE" ] }, "stroke": { "description": "Connector stroke (solid-fill only)", "type": "object", "properties": { "captype": { "description": "CapType enum", "type": "string", "maxLength": 20, "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "jointype": { "description": "JoinType enum", "type": "string", "maxLength": 20, "enum": [ "ROUND", "BEVEL", "MITER" ] }, "width": { "description": "Stroke width in pixels", "type": "number" }, "position": { "description": "StrokePosition enum", "type": "string", "maxLength": 20, "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "type": { "description": "StrokeType enum (connector-UI subset)", "type": "string", "maxLength": 50, "enum": [ "SOLID", "DASH", "SQUARE_DOT" ] }, "fill": { "description": "Connector stroke fill (solid-only; no_fill unsupported by UI)", "type": "object", "properties": { "solid": { "description": "Solid stroke fill (only variant supported on connectors)", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "alpha": { "description": "Stroke fill alpha / opacity (0.0 - 1.0)", "type": "number" } }, "required": [ "solid" ] } } } }, "required": [ "connected" ] }, "name": { "description": "Object name", "type": "string", "maxLength": 500 }, "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Object ID (mandatory, UUID)", "type": "string", "maxLength": 200 } }, "required": [ "id", "connector" ] } } }, "required": [ "elements" ] }, "FlatDeleteIdsRequest": { "type": "object", "properties": { "ids": { "minItems": 1, "maxItems": 100, "description": "Element IDs to delete (zone-scoped)", "type": "array", "items": { "type": "string", "maxLength": 500 } } }, "required": [ "ids" ] }, "FlatPutGroupShapesRequest": { "type": "object", "properties": { "elements": { "minItems": 1, "maxItems": 100, "description": "Per-element groupshape patches", "type": "array", "items": { "type": "object", "properties": { "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Element ID (UUID)", "type": "string", "maxLength": 500 }, "properties": { "description": "Group properties patch (layout only)", "type": "object", "properties": { "layout": { "description": "Group position and size (PATCH)", "type": "object", "properties": { "rotate": { "description": "Rotation angle in degrees", "type": "integer" }, "top": { "description": "Top position (Y)", "type": "number" }, "left": { "description": "Left position (X)", "type": "number" }, "width": { "description": "Width in pixels", "type": "number" }, "flipv": { "description": "Flip vertical", "type": "boolean" }, "fliph": { "description": "Flip horizontal", "type": "boolean" }, "height": { "description": "Height in pixels", "type": "number" } } } } } }, "required": [ "id" ] } } }, "required": [ "elements" ] }, "ShapeInsertRequest": { "type": "object", "properties": { "elements": { "minItems": 1, "maxItems": 100, "description": "Shape elements to insert", "type": "array", "items": { "type": "object", "properties": { "shape": { "description": "Shape (mandatory for shape insert)", "type": "object", "properties": { "shape": { "description": "Standard shape", "type": "object", "properties": { "callout": { "description": "Callout shape", "type": "object", "properties": { "type": { "description": "CalloutType enum", "type": "string", "maxLength": 40, "enum": [ "LINE", "RECTANGLE_CALLOUT", "ROUNDED_RECTANGLE_CALLOUT", "OVAL_CALLOUT", "CLOUD_CALLOUT" ] } } }, "mathematical_symbol": { "description": "Mathematical symbol", "type": "object", "properties": { "type": { "description": "MathematicalSymbolType enum", "type": "string", "maxLength": 10, "enum": [ "PLUS", "MINUS", "MULTIPLY", "DIVIDE", "EQUAL", "NOT_EQUAL" ] } } }, "star": { "description": "Star shape", "type": "object", "properties": { "ribbon": { "description": "Ribbon variant", "type": "object", "properties": { "type": { "description": "RibbonType enum", "type": "string", "maxLength": 15, "enum": [ "UP", "DOWN", "CURVED_UP", "CURVED_DOWN" ] } } }, "scroll": { "description": "Scroll variant", "type": "object", "properties": { "type": { "description": "ScrollType enum", "type": "string", "maxLength": 15, "enum": [ "VERTICAL", "HORIZONTAL" ] } } }, "type": { "description": "StarType enum", "type": "string", "maxLength": 15, "enum": [ "EXPLOSION", "POINT", "RIBBON", "SCROLL", "WAVE" ] }, "point": { "description": "Star point variant", "type": "object", "properties": { "type": { "description": "StarPointType enum", "type": "string", "maxLength": 25, "enum": [ "FOUR_POINT", "FIVE_POINT", "SIX_POINT", "SEVEN_POINT", "EIGHT_POINT", "TEN_POINT", "TWELVE_POINT", "SIXTEEN_POINT", "TWENTY_FOUR_POINT", "THIRTY_TWO_POINT" ] } } }, "wave": { "description": "Wave variant", "type": "object", "properties": { "type": { "description": "WaveType enum", "type": "string", "maxLength": 10, "enum": [ "SINGLE", "DOUBLE" ] } } } } }, "custom": { "description": "Custom path shape", "type": "object", "properties": { "paths": { "minItems": 1, "maxItems": 100, "description": "Shape paths (at least 1 required)", "type": "array", "items": { "type": "object", "properties": { "commands": { "minItems": 1, "maxItems": 5000, "description": "Path commands (at least 1 required)", "type": "array", "items": { "type": "object", "properties": { "smooth_cubic_to": { "description": "smooth cubic to. Max length: 500", "type": "object", "properties": { "control2": { "description": "Second control point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "End point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "control2", "end" ] }, "close_path": { "description": "close path. Max length: 100", "type": "object", "properties": {} }, "arc_to": { "description": "arc to. Max length: 500", "type": "object", "properties": { "x_radius": { "description": "X radius", "type": "number" }, "y_radius": { "description": "Y radius", "type": "number" }, "start_angle": { "description": "Start angle", "type": "number" }, "sweep_angle": { "description": "Sweep angle", "type": "number" }, "end": { "description": "End point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "end" ] }, "move_to": { "description": "move to. Max length: 200", "type": "object", "properties": { "point": { "description": "Move to point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "point" ] }, "quadratic_to": { "description": "quadratic to. Max length: 500", "type": "object", "properties": { "control": { "description": "Control point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "End point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "control", "end" ] }, "line_to": { "description": "line to. Max length: 200", "type": "object", "properties": { "point": { "description": "Line to point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "point" ] }, "cubic_to": { "description": "cubic to. Max length: 500", "type": "object", "properties": { "control2": { "description": "Second control point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "control1": { "description": "First control point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "End point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "control1", "control2", "end" ] }, "smooth_quadratic_to": { "description": "smooth quadratic to. Max length: 200", "type": "object", "properties": { "end": { "description": "End point (mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "end" ] } } } } }, "required": [ "commands" ] } }, "width": { "description": "Custom shape width", "type": "number" }, "height": { "description": "Custom shape height", "type": "number" } }, "required": [ "paths" ] }, "text": { "description": "Shape text content", "type": "object", "properties": { "placeholder": { "description": "Placeholder binding", "type": "object", "properties": { "type": { "description": "PlaceholderType enum (mandatory when placeholder binding is present)", "type": "string", "maxLength": 50, "enum": [ "TITLE", "SUBTITLE", "CONTENT", "IMAGE", "CHART", "TABLE" ] } }, "required": [ "type" ] }, "paragraphs": { "maxItems": 1000, "description": "Paragraphs", "type": "array", "items": { "type": "object", "properties": { "style": { "description": "Paragraph style", "type": "object", "properties": { "spacing": { "description": "Paragraph spacing", "type": "object", "properties": { "before": { "description": "Spacing before paragraph", "type": "integer" }, "line": { "description": "Line spacing", "type": "number" }, "after": { "description": "Spacing after paragraph", "type": "integer" } } }, "level": { "description": "Indent level", "type": "integer" }, "portion_style": { "description": "Default portion style", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Font size", "type": "number" }, "color": { "description": "Text color", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "underline": { "description": "Underline flag", "type": "boolean" }, "strike": { "description": "Strikethrough flag", "type": "boolean" }, "italic": { "description": "Italic flag", "type": "boolean" }, "font_name": { "description": "Font name object", "type": "object", "properties": { "name": { "description": "Font family name", "type": "string", "maxLength": 200, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] }, "style": { "description": "Font style", "type": "string", "maxLength": 100 } } } } }, "halign": { "description": "HorizontalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } }, "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Paragraph identifier (mandatory, UUID)", "type": "string", "maxLength": 200 }, "portions": { "maxItems": 500, "description": "Text runs (portions)", "type": "array", "items": { "type": "object", "properties": { "style": { "description": "Portion style", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Font size", "type": "number" }, "color": { "description": "Text color", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "underline": { "description": "Underline flag", "type": "boolean" }, "strike": { "description": "Strikethrough flag", "type": "boolean" }, "italic": { "description": "Italic flag", "type": "boolean" }, "font_name": { "description": "Font name object", "type": "object", "properties": { "name": { "description": "Font family name", "type": "string", "maxLength": 200, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] }, "style": { "description": "Font style", "type": "string", "maxLength": 100 } } } } }, "text": { "description": "Text content", "type": "string", "maxLength": 100000 } } } } }, "required": [ "id" ] } }, "properties": { "description": "Text properties (valign, inset, etc.)", "type": "object", "properties": { "inset": { "description": "Text padding", "type": "object", "properties": { "top": { "description": "Top padding", "type": "number" }, "left": { "description": "Left padding", "type": "number" }, "bottom": { "description": "Bottom padding", "type": "number" }, "right": { "description": "Right padding", "type": "number" } } }, "auto_fit": { "description": "TextBoxAutoFit enum", "type": "string", "maxLength": 20, "enum": [ "NONE", "TEXT", "SHAPE" ] }, "valign": { "description": "VerticalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "MIDDLE", "TOP", "BOTTOM" ] }, "para_style": { "description": "Default paragraph style", "type": "object", "properties": { "spacing": { "description": "Paragraph spacing", "type": "object", "properties": { "before": { "description": "Spacing before paragraph", "type": "integer" }, "line": { "description": "Line spacing", "type": "number" }, "after": { "description": "Spacing after paragraph", "type": "integer" } } }, "level": { "description": "Indent level", "type": "integer" }, "portion_style": { "description": "Default portion style", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Font size", "type": "number" }, "color": { "description": "Text color", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "underline": { "description": "Underline flag", "type": "boolean" }, "strike": { "description": "Strikethrough flag", "type": "boolean" }, "italic": { "description": "Italic flag", "type": "boolean" }, "font_name": { "description": "Font name object", "type": "object", "properties": { "name": { "description": "Font family name", "type": "string", "maxLength": 200, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] }, "style": { "description": "Font style", "type": "string", "maxLength": 100 } } } } }, "halign": { "description": "HorizontalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } } } } } }, "flowchart": { "description": "Flowchart shape", "type": "object", "properties": { "type": { "description": "FlowchartType enum", "type": "string", "maxLength": 40, "enum": [ "PREDEFINED_PROCESS", "INTERNAL_STORAGE", "DOCUMENT", "PROCESS", "ALTERNATE_PROCESS", "DECISION", "DATA", "MULTI_DOCUMENT", "TERMINATOR", "PREPARATION", "MANUAL_INPUT", "MANUAL_OPERATION", "CONNECTOR", "OFFPAGE_CONNECTOR", "PUNCHED_CARD", "PUNCHED_TAPE", "SUMMING_JUNCTION", "OR", "COLLATE", "SORT", "EXTRACT", "MERGE", "STORED_DATA", "DELAY", "SEQUENTIAL_ACCESS_STORAGE", "MAGNETIC_DISK", "DIRECT_ACCESS_STORAGE", "DISPLAY" ] } } }, "block_arrow": { "description": "Block arrow shape", "type": "object", "properties": { "double_arrow": { "description": "Double arrow direction", "type": "object", "properties": { "type": { "description": "DoubleArrowType enum", "type": "string", "maxLength": 15, "enum": [ "UP_DOWN", "LEFT_RIGHT", "LEFT_UP" ] } } }, "curved_arrow": { "description": "Curved arrow direction", "type": "object", "properties": { "type": { "description": "ArrowType enum", "type": "string", "maxLength": 10, "enum": [ "RIGHT", "LEFT", "TOP", "BOTTOM" ] } } }, "arrow_callout": { "description": "Arrow callout direction", "type": "object", "properties": { "type": { "description": "ArrowType enum", "type": "string", "maxLength": 10, "enum": [ "RIGHT", "LEFT", "TOP", "BOTTOM" ] } } }, "type": { "description": "BlockArrowType enum", "type": "string", "maxLength": 30, "enum": [ "SINGLE", "CURVED", "CALLOUT", "DOUBLE", "QUAD", "LEFT_RIGHT_UP", "BENT", "U_TURN", "BENT_UP", "STRIPED_RIGHT", "NOTCHED_RIGHT", "PENTAGON_ARROW", "CHEVRON", "LEFT_RIGHT_CALLOUT", "QUAD_CALLOUT" ] }, "single_arrow": { "description": "Single arrow direction", "type": "object", "properties": { "type": { "description": "ArrowType enum", "type": "string", "maxLength": 10, "enum": [ "RIGHT", "LEFT", "TOP", "BOTTOM" ] } } } } }, "placeholder": { "description": "Placeholder type", "type": "object", "properties": { "type": { "description": "PlaceholderType enum (mandatory when placeholder binding is present)", "type": "string", "maxLength": 50, "enum": [ "TITLE", "SUBTITLE", "CONTENT", "IMAGE", "CHART", "TABLE" ] } }, "required": [ "type" ] }, "basic": { "description": "Basic shape type", "type": "object", "properties": { "snip_rectangle": { "description": "Snip rectangle params", "type": "object", "properties": { "type": { "description": "SnipRectangleType enum", "type": "string", "maxLength": 20, "enum": [ "SNIP_SINGLE", "SNIP_SAME_SIDE", "SNIP_DIAGONAL" ] } } }, "rounded_rectangle": { "description": "Rounded rectangle params", "type": "object", "properties": { "type": { "description": "RoundedRectangleType enum", "type": "string", "maxLength": 20, "enum": [ "NORMAL", "SINGLE", "SAME_SIDE", "DIAGONAL" ] } } }, "bracket": { "description": "Bracket params", "type": "object", "properties": { "type": { "description": "BracketType enum", "type": "string", "maxLength": 10, "enum": [ "DOUBLE", "RIGHT", "LEFT" ] } } }, "brace": { "description": "Brace params", "type": "object", "properties": { "type": { "description": "BracketType enum (reused for Brace)", "type": "string", "maxLength": 10, "enum": [ "DOUBLE", "RIGHT", "LEFT" ] } } }, "type": { "description": "BasicShapeType enum", "type": "string", "maxLength": 30, "enum": [ "RECTANGLE", "ROUNDED_RECTANGLE", "SNIP_RECTANGLE", "ROUND_SNIP_RECTANGLE", "TRIANGLE", "OVAL", "TRAPEZOID", "PENTAGON", "HEXAGON", "DIAMOND", "PARALLELOGRAM", "HEPTAGON", "OCTAGON", "DECAGON", "PIE", "CHORD", "TEARDROP", "FRAME", "HALF_FRAME", "L_SHAPE", "DIAGONAL_STRIPE", "CROSS", "PLAQUE", "CAN", "CUBE", "BEVEL", "DONUT", "NO_SYMBOL", "BLOCK_ARC", "FOLDED_CORNER", "SMILEY", "HEART", "LIGHTNING_BOLT", "SUN", "MOON", "CLOUD", "ARC", "BRACKET", "BRACE", "CLOCK" ] }, "triangle": { "description": "Triangle params", "type": "object", "properties": { "type": { "description": "TriangleType enum", "type": "string", "maxLength": 20, "enum": [ "ISOSCELES", "RIGHT_ANGLED" ] } } } } }, "properties": { "description": "Shape properties (insert)", "type": "object", "properties": { "layout": { "description": "Position and size", "type": "object", "properties": { "rotate": { "description": "Rotation angle in degrees", "type": "integer" }, "top": { "description": "Top position (Y)", "type": "number" }, "left": { "description": "Left position (X)", "type": "number" }, "width": { "description": "Width in pixels", "type": "number" }, "flipv": { "description": "Flip vertical", "type": "boolean" }, "fliph": { "description": "Flip horizontal", "type": "boolean" }, "height": { "description": "Height in pixels", "type": "number" } } }, "strokes": { "maxItems": 10, "description": "Stroke layers", "type": "array", "items": { "type": "object", "properties": { "captype": { "description": "CapType enum", "type": "string", "maxLength": 20, "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "jointype": { "description": "JoinType enum", "type": "string", "maxLength": 20, "enum": [ "ROUND", "BEVEL", "MITER" ] }, "width": { "description": "Stroke width in pixels", "type": "number" }, "position": { "description": "StrokePosition enum", "type": "string", "maxLength": 20, "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "type": { "description": "StrokeType enum (UI subset: Solid/Dashed/Dotted; use fill.no_fill for 'no border')", "type": "string", "maxLength": 50, "enum": [ "SOLID", "DASH", "SQUARE_DOT" ] }, "fill": { "description": "Stroke fill (solid or no_fill; no_fill expresses 'no border')", "type": "object", "properties": { "solid": { "description": "Solid stroke fill (oneof variant)", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No stroke fill — stroke-off toggle (oneof variant)", "type": "object", "properties": {} }, "alpha": { "description": "Stroke fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } }, "fills": { "maxItems": 10, "description": "Fill layers", "type": "array", "items": { "type": "object", "properties": { "solid": { "description": "Solid fill", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No fill", "type": "object", "properties": {} }, "gradient": { "description": "Gradient fill", "type": "object", "properties": { "linear": { "description": "Geometry for LINEAR gradients", "type": "object", "properties": { "start": { "description": "Gradient axis start point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "Gradient axis end point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "start", "end" ] }, "radial_angular": { "description": "Geometry for RADIAL/ANGULAR gradients", "type": "object", "properties": { "flip_horizontal": { "description": "Mirror horizontally", "type": "boolean" }, "center": { "description": "Center point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "spread_x": { "description": "Horizontal spread (>= 0)", "type": "number" }, "spread_y": { "description": "Vertical spread (>= 0)", "type": "number" }, "rotation_angle": { "description": "Rotation in degrees", "type": "number" }, "flip_vertical": { "description": "Mirror vertically", "type": "boolean" } }, "required": [ "center" ] }, "stops": { "minItems": 2, "maxItems": 20, "description": "Gradient stops (minimum 2 required — a gradient needs from/to)", "type": "array", "items": { "type": "object", "properties": { "color": { "description": "Stop color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "position": { "description": "Stop position 0-1 (mandatory)", "type": "number" } }, "required": [ "color", "position" ] } }, "type": { "description": "GradientFillType enum (client renders LINEAR/RADIAL/ANGULAR only)", "type": "string", "maxLength": 50, "enum": [ "LINEAR", "RADIAL", "ANGULAR" ] } }, "required": [ "stops" ] }, "alpha": { "description": "Fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } } } } } }, "name": { "description": "Object name", "type": "string", "maxLength": 500 }, "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Object ID (mandatory, UUID)", "type": "string", "maxLength": 200 } }, "required": [ "id", "shape" ] } } }, "required": [ "elements" ] }, "GetTextRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/GetTextPayload" }, "object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "object" ] }, "FlatPutFramesRequest": { "type": "object", "properties": { "frames": { "minItems": 1, "maxItems": 100, "description": "Per-frame patches", "type": "array", "items": { "type": "object", "properties": { "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Element ID (UUID)", "type": "string", "maxLength": 500 }, "properties": { "description": "Frame properties patch", "type": "object", "properties": { "layout": { "description": "Position and size (PATCH)", "type": "object", "properties": { "rotate": { "description": "Rotation angle in degrees", "type": "integer" }, "top": { "description": "Top position (Y)", "type": "number" }, "left": { "description": "Left position (X)", "type": "number" }, "width": { "description": "Width in pixels", "type": "number" }, "flipv": { "description": "Flip vertical", "type": "boolean" }, "fliph": { "description": "Flip horizontal", "type": "boolean" }, "height": { "description": "Height in pixels", "type": "number" } } }, "strokes": { "maxItems": 10, "description": "Stroke layers (PATCH)", "type": "array", "items": { "type": "object", "properties": { "captype": { "description": "CapType enum", "type": "string", "maxLength": 20, "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "jointype": { "description": "JoinType enum", "type": "string", "maxLength": 20, "enum": [ "ROUND", "BEVEL", "MITER" ] }, "width": { "description": "Stroke width in pixels", "type": "number" }, "position": { "description": "StrokePosition enum", "type": "string", "maxLength": 20, "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "type": { "description": "StrokeType enum (UI subset: Solid/Dashed/Dotted; use fill.no_fill for 'no border')", "type": "string", "maxLength": 50, "enum": [ "SOLID", "DASH", "SQUARE_DOT" ] }, "fill": { "description": "Stroke fill (solid or no_fill; no_fill expresses 'no border')", "type": "object", "properties": { "solid": { "description": "Solid stroke fill (oneof variant)", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No stroke fill — stroke-off toggle (oneof variant)", "type": "object", "properties": {} }, "alpha": { "description": "Stroke fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } }, "fills": { "maxItems": 10, "description": "Fill layers (PATCH)", "type": "array", "items": { "type": "object", "properties": { "solid": { "description": "Solid fill", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No fill", "type": "object", "properties": {} }, "gradient": { "description": "Gradient fill", "type": "object", "properties": { "linear": { "description": "Geometry for LINEAR gradients", "type": "object", "properties": { "start": { "description": "Gradient axis start point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "Gradient axis end point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "start", "end" ] }, "radial_angular": { "description": "Geometry for RADIAL/ANGULAR gradients", "type": "object", "properties": { "flip_horizontal": { "description": "Mirror horizontally", "type": "boolean" }, "center": { "description": "Center point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "spread_x": { "description": "Horizontal spread (>= 0)", "type": "number" }, "spread_y": { "description": "Vertical spread (>= 0)", "type": "number" }, "rotation_angle": { "description": "Rotation in degrees", "type": "number" }, "flip_vertical": { "description": "Mirror vertically", "type": "boolean" } }, "required": [ "center" ] }, "stops": { "minItems": 2, "maxItems": 20, "description": "Gradient stops (minimum 2 required — a gradient needs from/to)", "type": "array", "items": { "type": "object", "properties": { "color": { "description": "Stop color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "position": { "description": "Stop position 0-1 (mandatory)", "type": "number" } }, "required": [ "color", "position" ] } }, "type": { "description": "GradientFillType enum (client renders LINEAR/RADIAL/ANGULAR only)", "type": "string", "maxLength": 50, "enum": [ "LINEAR", "RADIAL", "ANGULAR" ] } }, "required": [ "stops" ] }, "alpha": { "description": "Fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } } }, "required": [ "id" ] } } }, "required": [ "frames" ] }, "FlatPutConnectorsRequest": { "type": "object", "properties": { "elements": { "minItems": 1, "maxItems": 100, "description": "Per-element connector patches", "type": "array", "items": { "type": "object", "properties": { "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Element ID (UUID)", "type": "string", "maxLength": 500 }, "text": { "description": "Text label facet patch", "type": "object", "properties": { "mutations": { "maxItems": 100, "description": "Ordered text mutations", "type": "array", "items": { "type": "object", "properties": { "cursor": { "description": "Cursor-scoped insert/delete mutation", "type": "object", "properties": { "cursor_index": { "description": "Cursor index on flattened text", "type": "integer" }, "text": { "description": "Text to insert (required when operation=CURSOR_TEXT_OPERATION_INSERT_TEXT)", "type": "string", "maxLength": 500000 }, "operation": { "description": "Cursor mutation operation", "type": "string", "maxLength": 50, "enum": [ "CURSOR_TEXT_OPERATION_UNSPECIFIED", "CURSOR_TEXT_OPERATION_INSERT_TEXT", "CURSOR_TEXT_OPERATION_INSERT_NEWLINE", "CURSOR_TEXT_OPERATION_DELETE_NEWLINE" ] } }, "required": [ "cursor_index", "operation" ] }, "all_text": { "description": "Full-text replace/delete mutation", "type": "object", "properties": { "replacement_text": { "description": "Replacement text (required when operation=ALL_TEXT_OPERATION_REPLACE)", "type": "string", "maxLength": 500000 }, "operation": { "description": "Full-text mutation operation", "type": "string", "maxLength": 50, "enum": [ "ALL_TEXT_OPERATION_UNSPECIFIED", "ALL_TEXT_OPERATION_REPLACE", "ALL_TEXT_OPERATION_DELETE" ] } }, "required": [ "operation" ] }, "range": { "description": "Range-scoped replace/delete mutation", "type": "object", "properties": { "replacement_text": { "description": "Replacement text (required when operation=RANGE_TEXT_OPERATION_REPLACE)", "type": "string", "maxLength": 500000 }, "range": { "description": "Target range in flattened text", "type": "object", "properties": { "start_index": { "description": "Inclusive start index on flattened text (>= 0)", "type": "integer" }, "end_index": { "description": "Exclusive end index on flattened text (> start_index)", "type": "integer" } }, "required": [ "start_index", "end_index" ] }, "operation": { "description": "Range mutation operation", "type": "string", "maxLength": 50, "enum": [ "RANGE_TEXT_OPERATION_UNSPECIFIED", "RANGE_TEXT_OPERATION_REPLACE", "RANGE_TEXT_OPERATION_DELETE" ] } }, "required": [ "range", "operation" ] } } } }, "styles": { "maxItems": 100, "description": "Text style entries (one applyTextStyle call per entry)", "type": "array", "items": { "type": "object", "properties": { "all_text": { "description": "Apply style to entire flattened text when true", "type": "boolean" }, "portion_style": { "description": "Optional portion style patch", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Optional portion font size", "type": "number" }, "color": { "description": "Optional text color patch", "type": "object", "properties": { "hsb": { "description": "HSB color value", "type": "object", "properties": { "saturation": { "description": "Saturation 0-1", "type": "number" }, "brightness": { "description": "Brightness 0-1", "type": "number" }, "hue": { "description": "Hue in degrees", "type": "number" } } }, "hex": { "description": "Hex color value", "type": "object", "properties": { "value": { "description": "Hex color literal such as #8B4513", "type": "string", "maxLength": 50 } } }, "rgb": { "description": "RGB color value", "type": "object", "properties": { "red": { "description": "Red channel 0-255", "type": "integer" }, "green": { "description": "Green channel 0-255", "type": "integer" }, "blue": { "description": "Blue channel 0-255", "type": "integer" } } } } }, "underline": { "description": "Optional underline toggle", "type": "boolean" }, "strike": { "description": "Optional strike toggle", "type": "boolean" }, "italic": { "description": "Optional italic toggle", "type": "boolean" }, "font_name": { "description": "Optional font family/style patch", "type": "object", "properties": { "name": { "description": "Font display name", "type": "string", "maxLength": 500, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] } } } } }, "range": { "description": "Apply style within selected range", "type": "object", "properties": { "start_index": { "description": "Inclusive start index on flattened text (>= 0)", "type": "integer" }, "end_index": { "description": "Exclusive end index on flattened text (> start_index)", "type": "integer" } }, "required": [ "start_index", "end_index" ] }, "paragraph_style": { "description": "Optional paragraph style patch", "type": "object", "properties": { "spacing": { "description": "Optional paragraph spacing patch", "type": "object", "properties": { "before": { "description": "Optional space before paragraph in px; >= 0", "type": "integer" }, "line": { "description": "Optional line spacing multiplier (e.g. 1.2 = 120%); >= 0", "type": "number" }, "after": { "description": "Optional space after paragraph in px; >= 0", "type": "integer" } } }, "level": { "description": "Optional paragraph level", "type": "integer" }, "halign": { "description": "HorizontalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } } } } } } }, "properties": { "description": "Connector properties patch (strokes only)", "type": "object", "properties": { "strokes": { "maxItems": 1, "description": "Connector stroke (PATCH; at most one entry; solid-fill only)", "type": "array", "items": { "type": "object", "properties": { "captype": { "description": "CapType enum", "type": "string", "maxLength": 20, "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "jointype": { "description": "JoinType enum", "type": "string", "maxLength": 20, "enum": [ "ROUND", "BEVEL", "MITER" ] }, "width": { "description": "Stroke width in pixels", "type": "number" }, "position": { "description": "StrokePosition enum", "type": "string", "maxLength": 20, "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "type": { "description": "StrokeType enum (connector-UI subset)", "type": "string", "maxLength": 50, "enum": [ "SOLID", "DASH", "SQUARE_DOT" ] }, "fill": { "description": "Connector stroke fill (solid-only; no_fill unsupported by UI)", "type": "object", "properties": { "solid": { "description": "Solid stroke fill (only variant supported on connectors)", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "alpha": { "description": "Stroke fill alpha / opacity (0.0 - 1.0)", "type": "number" } }, "required": [ "solid" ] } } } } } } }, "required": [ "id" ] } } }, "required": [ "elements" ] }, "FlatPutShapesRequest": { "type": "object", "properties": { "elements": { "minItems": 1, "maxItems": 100, "description": "Per-element shape patches", "type": "array", "items": { "type": "object", "properties": { "id": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "description": "Element ID (UUID)", "type": "string", "maxLength": 500 }, "text": { "description": "Text facet patch (mutations and/or styles)", "type": "object", "properties": { "mutations": { "maxItems": 100, "description": "Ordered text mutations", "type": "array", "items": { "type": "object", "properties": { "cursor": { "description": "Cursor-scoped insert/delete mutation", "type": "object", "properties": { "cursor_index": { "description": "Cursor index on flattened text", "type": "integer" }, "text": { "description": "Text to insert (required when operation=CURSOR_TEXT_OPERATION_INSERT_TEXT)", "type": "string", "maxLength": 500000 }, "operation": { "description": "Cursor mutation operation", "type": "string", "maxLength": 50, "enum": [ "CURSOR_TEXT_OPERATION_UNSPECIFIED", "CURSOR_TEXT_OPERATION_INSERT_TEXT", "CURSOR_TEXT_OPERATION_INSERT_NEWLINE", "CURSOR_TEXT_OPERATION_DELETE_NEWLINE" ] } }, "required": [ "cursor_index", "operation" ] }, "all_text": { "description": "Full-text replace/delete mutation", "type": "object", "properties": { "replacement_text": { "description": "Replacement text (required when operation=ALL_TEXT_OPERATION_REPLACE)", "type": "string", "maxLength": 500000 }, "operation": { "description": "Full-text mutation operation", "type": "string", "maxLength": 50, "enum": [ "ALL_TEXT_OPERATION_UNSPECIFIED", "ALL_TEXT_OPERATION_REPLACE", "ALL_TEXT_OPERATION_DELETE" ] } }, "required": [ "operation" ] }, "range": { "description": "Range-scoped replace/delete mutation", "type": "object", "properties": { "replacement_text": { "description": "Replacement text (required when operation=RANGE_TEXT_OPERATION_REPLACE)", "type": "string", "maxLength": 500000 }, "range": { "description": "Target range in flattened text", "type": "object", "properties": { "start_index": { "description": "Inclusive start index on flattened text (>= 0)", "type": "integer" }, "end_index": { "description": "Exclusive end index on flattened text (> start_index)", "type": "integer" } }, "required": [ "start_index", "end_index" ] }, "operation": { "description": "Range mutation operation", "type": "string", "maxLength": 50, "enum": [ "RANGE_TEXT_OPERATION_UNSPECIFIED", "RANGE_TEXT_OPERATION_REPLACE", "RANGE_TEXT_OPERATION_DELETE" ] } }, "required": [ "range", "operation" ] } } } }, "styles": { "maxItems": 100, "description": "Text style entries (one applyTextStyle call per entry)", "type": "array", "items": { "type": "object", "properties": { "all_text": { "description": "Apply style to entire flattened text when true", "type": "boolean" }, "portion_style": { "description": "Optional portion style patch", "type": "object", "properties": { "fontweight": { "description": "FontWeight enum", "type": "string", "maxLength": 20, "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "size": { "description": "Optional portion font size", "type": "number" }, "color": { "description": "Optional text color patch", "type": "object", "properties": { "hsb": { "description": "HSB color value", "type": "object", "properties": { "saturation": { "description": "Saturation 0-1", "type": "number" }, "brightness": { "description": "Brightness 0-1", "type": "number" }, "hue": { "description": "Hue in degrees", "type": "number" } } }, "hex": { "description": "Hex color value", "type": "object", "properties": { "value": { "description": "Hex color literal such as #8B4513", "type": "string", "maxLength": 50 } } }, "rgb": { "description": "RGB color value", "type": "object", "properties": { "red": { "description": "Red channel 0-255", "type": "integer" }, "green": { "description": "Green channel 0-255", "type": "integer" }, "blue": { "description": "Blue channel 0-255", "type": "integer" } } } } }, "underline": { "description": "Optional underline toggle", "type": "boolean" }, "strike": { "description": "Optional strike toggle", "type": "boolean" }, "italic": { "description": "Optional italic toggle", "type": "boolean" }, "font_name": { "description": "Optional font family/style patch", "type": "object", "properties": { "name": { "description": "Font display name", "type": "string", "maxLength": 500, "enum": [ "Abel", "Adamina", "Alegreya", "Antic", "Anton", "Arapey", "Archivo", "Arvo", "Barlow", "Bentham", "Cabin", "Caveat", "Chivo", "Comfortaa", "Cookie", "Coustard", "Dosis", "Economica", "Exo", "Flamenco", "Gabriela", "Inter", "Italiana", "Jura", "Kalam", "Lato", "Lobster", "Magra", "Metrophobic", "Michroma", "Miltonian", "Molle", "Monoton", "Montez", "Montserrat", "Niconne", "Nosifer", "Nunito", "Oregano", "Oswald", "Pacifico", "Parisienne", "Philosopher", "Playball", "Pompiere", "Poppins", "Quando", "Questrial", "Quicksand", "Qwigley", "Raleway", "Roboto", "Rochester", "Rokkitt", "Rubik", "Sansation", "Satisfy", "Schoolbell", "Signika", "Syncopate", "Teko", "TeXGyreAdventor", "Ubuntu", "Unkempt", "Unna", "Vollkorn", "Yesteryear" ] } } } } }, "range": { "description": "Apply style within selected range", "type": "object", "properties": { "start_index": { "description": "Inclusive start index on flattened text (>= 0)", "type": "integer" }, "end_index": { "description": "Exclusive end index on flattened text (> start_index)", "type": "integer" } }, "required": [ "start_index", "end_index" ] }, "paragraph_style": { "description": "Optional paragraph style patch", "type": "object", "properties": { "spacing": { "description": "Optional paragraph spacing patch", "type": "object", "properties": { "before": { "description": "Optional space before paragraph in px; >= 0", "type": "integer" }, "line": { "description": "Optional line spacing multiplier (e.g. 1.2 = 120%); >= 0", "type": "number" }, "after": { "description": "Optional space after paragraph in px; >= 0", "type": "integer" } } }, "level": { "description": "Optional paragraph level", "type": "integer" }, "halign": { "description": "HorizontalAlignType enum", "type": "string", "maxLength": 20, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } } } } } } }, "properties": { "description": "Shape properties patch", "type": "object", "properties": { "layout": { "description": "Position and size (PATCH)", "type": "object", "properties": { "rotate": { "description": "Rotation angle in degrees", "type": "integer" }, "top": { "description": "Top position (Y)", "type": "number" }, "left": { "description": "Left position (X)", "type": "number" }, "width": { "description": "Width in pixels", "type": "number" }, "flipv": { "description": "Flip vertical", "type": "boolean" }, "fliph": { "description": "Flip horizontal", "type": "boolean" }, "height": { "description": "Height in pixels", "type": "number" } } }, "strokes": { "maxItems": 10, "description": "Stroke layers (PATCH; full replace when present)", "type": "array", "items": { "type": "object", "properties": { "captype": { "description": "CapType enum", "type": "string", "maxLength": 20, "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "jointype": { "description": "JoinType enum", "type": "string", "maxLength": 20, "enum": [ "ROUND", "BEVEL", "MITER" ] }, "width": { "description": "Stroke width in pixels", "type": "number" }, "position": { "description": "StrokePosition enum", "type": "string", "maxLength": 20, "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "type": { "description": "StrokeType enum (UI subset: Solid/Dashed/Dotted; use fill.no_fill for 'no border')", "type": "string", "maxLength": 50, "enum": [ "SOLID", "DASH", "SQUARE_DOT" ] }, "fill": { "description": "Stroke fill (solid or no_fill; no_fill expresses 'no border')", "type": "object", "properties": { "solid": { "description": "Solid stroke fill (oneof variant)", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No stroke fill — stroke-off toggle (oneof variant)", "type": "object", "properties": {} }, "alpha": { "description": "Stroke fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } }, "fills": { "maxItems": 10, "description": "Fill layers (PATCH; full replace when present)", "type": "array", "items": { "type": "object", "properties": { "solid": { "description": "Solid fill", "type": "object", "properties": { "color": { "description": "Fill color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } } }, "required": [ "color" ] }, "no_fill": { "description": "No fill", "type": "object", "properties": {} }, "gradient": { "description": "Gradient fill", "type": "object", "properties": { "linear": { "description": "Geometry for LINEAR gradients", "type": "object", "properties": { "start": { "description": "Gradient axis start point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "end": { "description": "Gradient axis end point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } } }, "required": [ "start", "end" ] }, "radial_angular": { "description": "Geometry for RADIAL/ANGULAR gradients", "type": "object", "properties": { "flip_horizontal": { "description": "Mirror horizontally", "type": "boolean" }, "center": { "description": "Center point (normalized, mandatory)", "type": "object", "properties": { "x": { "description": "X coordinate", "type": "number" }, "y": { "description": "Y coordinate", "type": "number" } } }, "spread_x": { "description": "Horizontal spread (>= 0)", "type": "number" }, "spread_y": { "description": "Vertical spread (>= 0)", "type": "number" }, "rotation_angle": { "description": "Rotation in degrees", "type": "number" }, "flip_vertical": { "description": "Mirror vertically", "type": "boolean" } }, "required": [ "center" ] }, "stops": { "minItems": 2, "maxItems": 20, "description": "Gradient stops (minimum 2 required — a gradient needs from/to)", "type": "array", "items": { "type": "object", "properties": { "color": { "description": "Stop color (mandatory)", "type": "object", "properties": { "hsb": { "description": "HSB color", "type": "object", "properties": { "saturation": { "description": "Saturation value (0-1, mandatory)", "type": "number" }, "brightness": { "description": "Brightness value (0-1, mandatory)", "type": "number" }, "hue": { "description": "Hue value (0-360, mandatory)", "type": "number" } }, "required": [ "hue", "saturation", "brightness" ] }, "hex": { "description": "Hex color", "type": "object", "properties": { "value": { "description": "Hex color string e.g. #4A90D9 (mandatory)", "type": "string", "maxLength": 20 } }, "required": [ "value" ] }, "rgb": { "description": "RGB color", "type": "object", "properties": { "red": { "description": "Red channel (0-255, mandatory)", "type": "integer" }, "green": { "description": "Green channel (0-255, mandatory)", "type": "integer" }, "blue": { "description": "Blue channel (0-255, mandatory)", "type": "integer" } }, "required": [ "red", "green", "blue" ] } } }, "position": { "description": "Stop position 0-1 (mandatory)", "type": "number" } }, "required": [ "color", "position" ] } }, "type": { "description": "GradientFillType enum (client renders LINEAR/RADIAL/ANGULAR only)", "type": "string", "maxLength": 50, "enum": [ "LINEAR", "RADIAL", "ANGULAR" ] } }, "required": [ "stops" ] }, "alpha": { "description": "Fill alpha / opacity (0.0 - 1.0)", "type": "number" } } } } } } }, "required": [ "id" ] } } }, "required": [ "elements" ] }, "GroupOpRequest": { "type": "object", "properties": { "op": { "description": "Group operation", "type": "string", "maxLength": 50, "enum": [ "group", "ungroup" ] }, "nested_groups": { "minItems": 1, "maxItems": 10000, "description": "Array-of-arrays of uuids (required for op=group)", "type": "array", "items": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "type": "string", "maxLength": 100 } }, "groups": { "minItems": 1, "maxItems": 10000, "description": "Flat uuid list (required for op=ungroup)", "type": "array", "items": { "pattern": "^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12}$", "type": "string", "maxLength": 100 } } }, "required": [ "op" ] }, "ObjectRef": { "type": "object", "properties": { "zone_id": { "type": "string" }, "object_id": { "type": "string" }, "frame_id": { "type": "string" } } } }, "responses": { "NotFoundAResourceNamedInThePathDoesNotEx3": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Non-Existent Frame": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1002", "message": "Frame not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/00000000-0000-0000-0000-000000000000/groupshapes", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx4": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Non-Existent Frame": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1002", "message": "Frame not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/00000000-0000-0000-0000-000000000000/shapes", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx2": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Non-Existent Frame": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1002", "message": "Frame not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/00000000-0000-0000-0000-000000000000/frames", "status": "error" } } } } } }, "UnauthorizedMissingOrInvalidAccessToken3": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } } } } } }, "InternalServerErrorTheRequestWasWellForm": { "description": "Internal server error - the request was well-formed but could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "UnauthorizedMissingOrInvalidAccessToken4": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } } } } } }, "UnauthorizedMissingOrInvalidAccessToken5": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } } } } } }, "UnauthorizedMissingOrInvalidAccessToken6": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Non-Existent Frame": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1002", "message": "Frame not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/00000000-0000-0000-0000-000000000000/connectors", "status": "error" } } } } } }, "UnauthorizedMissingOrInvalidAccessToken7": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/groupshapes", "status": "error" } } } } } }, "UnauthorizedMissingOrInvalidAccessToken8": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/shapes", "status": "error" } } } } } }, "RateLimitExceededThisOperationAllows60Re": { "description": "Rate limit exceeded - this operation allows 60 requests per minute per user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "UnauthorizedMissingOrInvalidAccessToken": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/connectors", "status": "error" } } } } } }, "UnauthorizedMissingOrInvalidAccessToken2": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600097" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600097/zones/94784afb-38f7-4b2c-a189-23ebb2f5953a/frames", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx7": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/connectors", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx8": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/groupshapes", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx5": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx6": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/shapes", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } } } } } }, "NotFoundAResourceNamedInThePathDoesNotEx9": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "error" } } } } } } }, "securitySchemes": { "vani-api-key": { "in": "header", "name": "x-vani-apikey", "description": "Edition-scoped API key. ACCEPTED, NOT YET REQUIRED: the bearer token alone authorises every operation today, which is why each one lists a token-only alternative first and a token-plus-key alternative second. Sending the key is harmless and forward-compatible -- the server reads it, and the requirement is expected to become mandatory, at which point the token-only alternative disappears from this contract. The key never authorises on its own. Read or create your edition's key from the edition settings. The two operations on the /editions collection itself never carry one: a key belongs to an edition, so the calls that list or create editions cannot present it.", "type": "apiKey" }, "iam-oauth2-schema": { "flows": { "authorizationCode": { "tokenUrl": "https://accounts.zoho.com/oauth/v2/token", "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "scopes": { "Vani.teams.UPDATE": "Update team memberships, roles, and collaboration settings", "Vani.spaces.UPDATE": "Update workspaces, folders, and organizational settings", "Vani.spaces.DELETE": "Delete workspaces and folders", "Vani.zones.READ": "Read zones including tables, cells, and paragraph content", "Vani.editions.UPDATE": "Update existing document editions, modify version metadata and publishing state", "Vani.spaces.CREATE": "Create new workspaces, folders, and organizational structure", "Vani.teams.CREATE": "Create new teams and assign team memberships", "Vani.spaces.READ": "Read workspaces, folders, and organizational structure", "Vani.editions.CREATE": "Create new document editions and version snapshots", "Vani.zones.CREATE": "Create zones including tables, cells, and paragraph content", "Vani.teams.READ": "Read team memberships, roles, and collaboration settings", "Vani.editions.READ": "Read document editions, version history, and edition metadata", "Vani.teams.DELETE": "Delete teams and remove team memberships" } } }, "x-vani-data-centre": "com", "description": "OAuth 2.0 through Zoho Accounts for the .com data centre (the default). Authorisation is NOT served by the API server -- it is a separate host, and each data centre has its own. If your edition is on another data centre, keep these paths and substitute its host from x-vani-accounts-hosts on this scheme. An OAuth client is valid only in the data centre it was registered in, so register at that data centre's api-console. Note that the accounts host does not simply mirror the API host's TLD: Canada authorises at accounts.zohocloud.ca.", "x-vani-accounts-hosts": { "com": "accounts.zoho.com", "eu": "accounts.zoho.eu", "ae": "accounts.zoho.ae", "in": "accounts.zoho.in", "ca": "accounts.zohocloud.ca", "sa": "accounts.zoho.sa", "com.au": "accounts.zoho.com.au" }, "type": "oauth2" } }, "parameters": { "ZoneId": { "schema": { "type": "string" }, "in": "path", "name": "zone_id", "description": "The unique identifier of the zone", "required": true }, "FetchType": { "schema": { "x-enumDescriptions": { "paragraph_text": "Return the text of a paragraph range.", "length": "Return the character count only.", "paragraph_count": "Return the number of paragraphs only.", "text": "Return the flattened plain text of the object." }, "type": "string", "maxLength": 50, "enum": [ "text", "length", "paragraph_count", "paragraph_text" ] }, "in": "query", "name": "fetch_type", "description": "Optional text fetch mode. Use one of: text, length, paragraph_count, paragraph_text. Defaults to text. Allowed values: text, length, paragraph_count, paragraph_text", "required": false }, "TextId": { "schema": { "type": "string" }, "in": "path", "name": "text_id", "description": "The unique identifier of the text", "required": true }, "SpaceId": { "schema": { "type": "string" }, "in": "path", "name": "space_id", "description": "The unique identifier of the space", "required": true }, "Ids": { "schema": { "pattern": "^(?:(^[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12})((,[a-f0-9A-F]{8}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{4}-[a-f0-9A-F]{12})*)?)$", "type": "string", "maxLength": 5000 }, "in": "query", "name": "ids", "description": "Optional comma-separated UUID list to fetch selected items", "required": false }, "EditionId": { "schema": { "type": "string" }, "in": "path", "name": "edition_id", "description": "The unique identifier of the edition", "required": true }, "FrameId": { "schema": { "type": "string" }, "in": "path", "name": "frame_id", "description": "The unique identifier of the frame", "required": true }, "TextQuery": { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetTextRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetTextRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string", "maxLength": 500000 }, "in": "query", "name": "text_query", "description": "`text_query` — JSON-encoded read options, URL-encoded. Whether it is required depends on fetch_type. REQUIRED with fetch_type=text: pass {\"payload\":{\"all_text\":true}} for the whole text, or {\"payload\":{\"range\":{\"start_index\":0,\"end_index\":5}}} for a character range. REQUIRED with fetch_type=paragraph_text: pass {\"payload\":{\"range\":{\"start_paragraph_index\":0,\"end_paragraph_index\":1}}}. Not needed with fetch_type=length or fetch_type=paragraph_count, which ignore it. Omitting it where it is required fails validation, so it is declared optional on the parameter only because two of the four modes do not use it. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": false } } }, "servers": [ { "variables": { "dc": { "default": "com", "description": "Data-centre TLD for your edition.", "enum": [ "com", "in", "eu", "ca", "com.au", "sa", "ae" ] } }, "description": "Vani API server. Select the data centre your edition is hosted in.", "url": "https://api.app.vanihq.{dc}" } ], "openapi": "3.1.0", "paths": { "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/connectors": { "post": { "summary": "Insert one or more connectors into a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorInsertRequest" } } } }, "operationId": "createZoneConnector", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "inserted_ids": [ "0c1c8b83-2264-544f-a5a6-f0b09ff8df38", "fe557711-f11e-5cda-add7-62cbb92b93ea", "2394a2a8-7984-565a-9e10-bdc399a950de", "0f6bf425-0e92-50f6-bc3d-bfda4773fad8", "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8" ] }, "message": "Connectors inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "inserted_ids": [ "589098f2-b8f9-50bb-b7c7-3bbf85c9e632" ], "errors": [ { "id": "33333333-2222-4222-8222-bbbbbbbbbbbb", "error": "Shape BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8 not found in zone" }, { "id": "33333333-4444-4444-8444-dddddddddddd", "error": "Shape BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8 not found in zone" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "success" } }, "Failure": { "value": { "data": { "inserted_ids": [], "errors": [ { "id": "33333333-2222-4222-8222-bbbbbbbbbbbb", "error": "Shape BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8 not found in zone" }, { "id": "33333333-4444-4444-8444-dddddddddddd", "error": "Shape BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8 not found in zone" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "success" } }, "Single Element": { "value": { "data": { "inserted_ids": [ "299098f2-b8f9-50bb-b7c7-3bbf85c9e628" ] }, "message": "Connectors inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/connectors", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx7" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors" ] }, "get": { "summary": "Get the connectors in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZoneConnectors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "total_count": 3, "elements": [ { "connector": { "connected": { "first": { "marker": "DIAMOND", "shape_id": "6FE655E1-6039-46E1-BECA-30067ED96517" }, "second": { "side": "WEST", "marker": "OVAL", "shape_id": "8BB93A22-6976-4976-AA4C-417D16BA8876" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a3333333-3333-5333-8333-333333333333", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Curve (diamond → oval)" } ] } ], "properties": {} }, "type": "CURVE", "stroke": { "captype": "CAPROUND", "width": 3, "type": "SQUARE_DOT", "fill": { "solid": { "color": { "rgb": { "red": 156, "green": 39, "blue": 176 } } } } } }, "id": "2394a2a8-7984-565a-9e10-bdc399a950de" }, { "connector": { "connected": { "first": { "side": "NORTH", "marker": "OPEN", "shape_id": "01EEDC0C-45EC-44A3-96F6-740155ACE02C" }, "second": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "B579FA1E-B4D2-41BC-B543-25B3C1790314" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "3ab1987e-7e55-516b-a3c7-5248626bab9c", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Elbow with label" } ] } ], "properties": {} }, "type": "ELBOW", "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 76, "green": 175, "blue": 80 } } } } } }, "id": "0f6bf425-0e92-50f6-bc3d-bfda4773fad8" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "62E4A270-79F6-44F8-A381-9BDB9718DFC4" }, "second": { "side": "WEST", "marker": "CLASSIC", "shape_id": "F4F4F69D-2B6E-4241-9A87-79393F0D0F50" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a5555555-5555-5555-8555-555555555555", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Line (point attach)" } ] } ], "properties": {} }, "stroke": { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 244, "green": 67, "blue": 54 } } } } } }, "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8" } ] }, "message": "Connectors fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 2, "elements": [ { "connector": { "connected": { "first": { "side": "NORTH", "marker": "OPEN", "shape_id": "01EEDC0C-45EC-44A3-96F6-740155ACE02C" }, "second": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "B579FA1E-B4D2-41BC-B543-25B3C1790314" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "3ab1987e-7e55-516b-a3c7-5248626bab9c", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Elbow with label" } ] } ], "properties": {} }, "type": "ELBOW", "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 76, "green": 175, "blue": 80 } } } } } }, "id": "0f6bf425-0e92-50f6-bc3d-bfda4773fad8" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "62E4A270-79F6-44F8-A381-9BDB9718DFC4" }, "second": { "side": "WEST", "marker": "CLASSIC", "shape_id": "F4F4F69D-2B6E-4241-9A87-79393F0D0F50" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a5555555-5555-5555-8555-555555555555", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Line (point attach)" } ] } ], "properties": {} }, "stroke": { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 244, "green": 67, "blue": 54 } } } } } }, "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8" } ], "errors": [ { "error_code": "EL1001", "id": "2394a2a8-7984-565a-9e10-bdc399a950df", "message": "Element not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Default": { "value": { "data": { "total_count": 5, "elements": [ { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "34670950-CCC1-4339-BAA1-5D8EF6AA110D" }, "second": { "side": "WEST", "marker": "OPEN", "shape_id": "3194713B-6542-4303-A1D1-1E3A5E75596F" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a1111111-1111-5111-8111-111111111111", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Line (none → open)" } ] } ], "properties": {} }, "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 66, "green": 133, "blue": 244 } } } } } }, "id": "0c1c8b83-2264-544f-a5a6-f0b09ff8df38" }, { "connector": { "connected": { "first": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "A9A88769-7EB9-40A6-BC13-656E6A2FAB90" }, "second": { "side": "NORTH", "marker": "CLASSIC", "shape_id": "2498BB05-97D3-42D3-AB10-F34AC472971A" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a2222222-2222-5222-8222-222222222222", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Elbow (block → classic)" } ] } ], "properties": {} }, "type": "ELBOW", "stroke": { "captype": "CAPROUND", "width": 2, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 255, "green": 152 } } } } } }, "id": "fe557711-f11e-5cda-add7-62cbb92b93ea" }, { "connector": { "connected": { "first": { "marker": "DIAMOND", "shape_id": "6FE655E1-6039-46E1-BECA-30067ED96517" }, "second": { "side": "WEST", "marker": "OVAL", "shape_id": "8BB93A22-6976-4976-AA4C-417D16BA8876" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a3333333-3333-5333-8333-333333333333", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Curve (diamond → oval)" } ] } ], "properties": {} }, "type": "CURVE", "stroke": { "captype": "CAPROUND", "width": 3, "type": "SQUARE_DOT", "fill": { "solid": { "color": { "rgb": { "red": 156, "green": 39, "blue": 176 } } } } } }, "id": "2394a2a8-7984-565a-9e10-bdc399a950de" }, { "connector": { "connected": { "first": { "side": "NORTH", "marker": "OPEN", "shape_id": "01EEDC0C-45EC-44A3-96F6-740155ACE02C" }, "second": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "B579FA1E-B4D2-41BC-B543-25B3C1790314" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "3ab1987e-7e55-516b-a3c7-5248626bab9c", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Elbow with label" } ] } ], "properties": {} }, "type": "ELBOW", "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 76, "green": 175, "blue": 80 } } } } } }, "id": "0f6bf425-0e92-50f6-bc3d-bfda4773fad8" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "62E4A270-79F6-44F8-A381-9BDB9718DFC4" }, "second": { "side": "WEST", "marker": "CLASSIC", "shape_id": "F4F4F69D-2B6E-4241-9A87-79393F0D0F50" } }, "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "a5555555-5555-5555-8555-555555555555", "portions": [ { "style": { "fontweight": "NORMAL" }, "text": "Line (point attach)" } ] } ], "properties": {} }, "stroke": { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 244, "green": 67, "blue": 54 } } } } } }, "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8" } ] }, "message": "Connectors fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1001", "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed2", "message": "Element not found" }, { "error_code": "EL1001", "id": "0f6bf425-0e92-50f6-bc3d-bfda4793fad8", "message": "Element not found" }, { "error_code": "EL1001", "id": "2394a2a8-7984-565a-9e10-bdc399a940df", "message": "Element not found" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/connectors", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/connectors", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx7" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors" ] }, "delete": { "summary": "Delete one or more connectors from a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteZoneConnectors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "shape_id": "2394a2a8-7984-565a-9e10-bdc399a950de", "status": "success" }, { "shape_id": "27613A45-CC58-4EAA-9A13-60C865CE038A", "status": "success" }, { "shape_id": "909813A9-CB90-4F51-BD7A-2D96E3F02B35", "status": "success" }, { "shape_id": "EA5CEF19-D92C-4053-8410-EC29594F3DE6", "status": "success" } ] }, "message": "Connectors deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "shape_id": "DAC2735E-73CF-4848-824C-CF0C4BC7B1BA", "status": "success" }, { "shape_id": "1F002149-7282-45FF-8624-B9E3EA489EB0", "status": "success" }, { "id": "2F002149-7283-45FF-8624-B9E3EA499EB7", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "DAC2735E-73CF-4848-824C-CF0C4BC7B9BA", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" }, { "id": "2F002149-7283-45FF-8624-B9E3EA499EB7", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "shape_id": "AFFA3D04-1FD9-44EC-B031-501DD296EF6D", "status": "success" } ] }, "message": "Connectors deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/connectors", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx7" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors" ] }, "put": { "summary": "Update one or more connectors in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutConnectorsRequest" } } } }, "operationId": "updateZoneConnectors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "id": "0c1c8b83-2264-544f-a5a6-f0b09ff8df38", "status": "success" }, { "id": "fe557711-f11e-5cda-add7-62cbb92b93ea", "status": "success" }, { "id": "2394a2a8-7984-565a-9e10-bdc399a950de", "status": "success" }, { "id": "0f6bf425-0e92-50f6-bc3d-bfda4773fad8", "status": "success" }, { "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8", "status": "success" } ] }, "message": "Connectors updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "id": "9c1c8b83-2264-544f-a5a6-f0b09ff8df38", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "fe557711-f11e-5cda-add7-62cbb92b93ea", "status": "success" }, { "id": "2394a2a8-7984-565a-9e10-bdc399a950de", "status": "success" }, { "id": "0f6bf425-0e92-50f6-bc3d-bfda4773fad8", "status": "success" }, { "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8", "errors": [ { "error_code": "EL1018", "message": "mutations[2]: No newline found at/before cursor index 1", "facet": "text_mutations" } ], "status": "partial" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "9c1c8b83-2264-544f-a5a6-f0b09ff8df38", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "1394a2a8-7984-565a-9e10-bdc399a950de", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "660e559f-e2fd-5d6e-a69a-e55a9d0e0ed8", "errors": [ { "error_code": "EL1018", "message": "mutations[0]: Invalid text range [1, 9999). Text length: 25; mutations[1..2] not attempted", "facet": "text_mutations" }, { "error_code": "EL1018", "message": "styles[0]: Invalid text range [0, 9999). Text length: 25", "facet": "text_styles" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "id": "fe557711-f11e-5cda-add7-62cbb92b93ea", "status": "success" } ] }, "message": "Connectors updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/connectors", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/connectors", "status": "error" } }, "No Facet (Neither properties nor text)": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "EL1018", "message": "elements[0] must carry at least one of 'properties' or 'text'", "space_id": "5777000000911002" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000911002/zones/aa41bbd3-56b9-49e6-b3c0-0545de0c33c6/connectors", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/connectors", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "5777000000915007" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/connectors", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx7" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/frames/{frame_id}/connectors": { "post": { "summary": "Insert one or more connectors into a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectorInsertRequest" } } } }, "operationId": "createFrameConnector", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "connector_id": "22222222-1111-4111-8111-aaaaaaaaaaaa", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "connector_id": "22222222-2222-4222-8222-bbbbbbbbbbbb", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "connector_id": "22222222-3333-4333-8333-cccccccccccc", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "connector_id": "22222222-4444-4444-8444-dddddddddddd", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "connector_id": "22222222-5555-4555-8555-eeeeeeeeeeee", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Connectors inserted in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "connector_id": "33333333-1111-4111-8111-aaaaaaaaaaaa", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ], "errors": [ { "index": 1, "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1001", "message": "Shape 00000000-0000-4000-8000-000000000000 not found in frame" }, { "index": 2, "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1001", "message": "Shape B51D762D-BC85-4377-9529-5752FBE21305 not found in frame" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "index": 0, "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1001", "message": "Shape 00000000-0000-4000-8000-000000000000 not found in frame" }, { "index": 1, "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1001", "message": "Shape B51D762D-BC85-4377-9529-5752FBE21305 not found in frame" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "connector_id": "11111111-aaaa-4bbb-8ccc-111111111112", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Connectors inserted in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken3" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors on Frame" ] }, "get": { "summary": "Get the connectors in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getFrameConnectors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "total_count": 4, "elements": [ { "connector": { "stroke": { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } }, "id": "B37069B4-6676-4B1D-9DE8-13BF28854044" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, "second": { "side": "WEST", "marker": "OPEN", "shape_id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "bbbbbbbb-2222-4222-8222-bbbbbbbbbbbb", "portions": [ { "style": { "fontweight": "NORMAL", "size": 12, "color": { "rgb": { "red": 30, "green": 30, "blue": 30 } } }, "text": "Line A→C" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 66, "green": 133, "blue": 244 } } }, "alpha": 1 } } }, "id": "22222222-1111-4111-8111-aaaaaaaaaaaa" }, { "connector": { "connected": { "first": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "757F7D65-EDBB-4447-B743-5520B1BA3667" }, "second": { "side": "NORTH", "marker": "CLASSIC", "shape_id": "C4A58170-EB6A-4C1F-8705-9DD091E900D4" } }, "text": { "paragraphs": [ { "style": { "spacing": { "before": 2, "line": 1.3 }, "level": 1 }, "id": "cccccccc-3333-4333-8333-cccccccccccc", "portions": [ { "style": { "fontweight": "BOLD", "size": 13, "color": { "rgb": { "red": 33, "green": 33, "blue": 33 } } }, "text": "Elbow " }, { "style": { "fontweight": "NORMAL", "size": 13, "color": { "rgb": { "red": 255, "green": 109 } } }, "text": "D→F" } ] } ], "properties": { "inset": { "top": 2, "left": 4, "bottom": 2, "right": 4 }, "auto_fit": "TEXT", "valign": "TOP" } }, "type": "ELBOW", "stroke": { "captype": "CAPROUND", "jointype": "BEVEL", "width": 2.5, "position": "INSIDE", "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 255, "green": 152 } } } } } }, "id": "22222222-2222-4222-8222-bbbbbbbbbbbb" }, { "connector": { "connected": { "first": { "side": "SOUTH", "marker": "NONE", "shape_id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f014" }, "second": { "side": "NORTH", "marker": "BLOCK", "shape_id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f018" } }, "type": "ELBOW", "stroke": { "width": 1.5, "fill": { "solid": { "color": { "rgb": { "red": 13, "green": 71, "blue": 161 } } } } } }, "id": "33333333-1111-4111-8111-aaaaaaaaaaaa" } ] }, "message": "Connectors in frame fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 1, "elements": [ { "connector": { "stroke": { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } }, "id": "B37069B4-6676-4B1D-9DE8-13BF28854044" } ], "errors": [ { "error_code": "EL1001", "id": "22222222-1111-4111-8111-aaaaaaaaaaa1", "message": "Element not found" }, { "error_code": "EL1001", "id": "22222222-2222-4222-8222-bbbbbbbbbbbc", "message": "Element not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Default": { "value": { "data": { "total_count": 9, "elements": [ { "connector": { "stroke": { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } }, "id": "B37069B4-6676-4B1D-9DE8-13BF28854044" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, "second": { "side": "WEST", "marker": "OPEN", "shape_id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "bbbbbbbb-2222-4222-8222-bbbbbbbbbbbb", "portions": [ { "style": { "fontweight": "NORMAL", "size": 12, "color": { "rgb": { "red": 30, "green": 30, "blue": 30 } } }, "text": "Line A→C" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 66, "green": 133, "blue": 244 } } }, "alpha": 1 } } }, "id": "22222222-1111-4111-8111-aaaaaaaaaaaa" }, { "connector": { "connected": { "first": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "757F7D65-EDBB-4447-B743-5520B1BA3667" }, "second": { "side": "NORTH", "marker": "CLASSIC", "shape_id": "C4A58170-EB6A-4C1F-8705-9DD091E900D4" } }, "text": { "paragraphs": [ { "style": { "spacing": { "before": 2, "line": 1.3 }, "level": 1 }, "id": "cccccccc-3333-4333-8333-cccccccccccc", "portions": [ { "style": { "fontweight": "BOLD", "size": 13, "color": { "rgb": { "red": 33, "green": 33, "blue": 33 } } }, "text": "Elbow " }, { "style": { "fontweight": "NORMAL", "size": 13, "color": { "rgb": { "red": 255, "green": 109 } } }, "text": "D→F" } ] } ], "properties": { "inset": { "top": 2, "left": 4, "bottom": 2, "right": 4 }, "auto_fit": "TEXT", "valign": "TOP" } }, "type": "ELBOW", "stroke": { "captype": "CAPROUND", "jointype": "BEVEL", "width": 2.5, "position": "INSIDE", "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 255, "green": 152 } } } } } }, "id": "22222222-2222-4222-8222-bbbbbbbbbbbb" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "DIAMOND", "shape_id": "590A322C-1E47-425D-97C2-4DE977E3AE90" }, "second": { "side": "WEST", "marker": "OVAL", "shape_id": "BB215227-9219-4512-9E81-BEF0D7B3FC71" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.4, "after": 4 }, "level": 2, "halign": "RIGHT" }, "id": "dddddddd-4444-4444-8444-dddddddddddd", "portions": [ { "style": { "fontweight": "MEDIUM", "size": 14, "color": { "hsb": { "saturation": 0.6, "brightness": 0.55, "hue": 0.7777778 } }, "italic": true, "font_name": { "name": "Roboto" } }, "text": "Curve G→I" } ] } ], "properties": { "inset": { "top": 3, "left": 3, "bottom": 3, "right": 3 }, "auto_fit": "SHAPE", "valign": "BOTTOM" } }, "type": "CURVE", "stroke": { "captype": "SQUARE", "jointype": "MITER", "width": 1.75, "position": "OUTSIDE", "type": "SQUARE_DOT", "fill": { "solid": { "color": { "hsb": { "saturation": 0.6, "brightness": 0.55, "hue": 0.7777778 } } }, "alpha": 0.9 } } }, "id": "22222222-3333-4333-8333-cccccccccccc" }, { "connector": { "connected": { "first": { "side": "NORTH", "marker": "OPEN", "shape_id": "33D9BFC3-A1DD-46B4-A6EC-36C53F02A10B" }, "second": { "side": "SOUTH", "marker": "BLOCK", "shape_id": "A27E27D3-7D11-437C-B006-EE48F3356200" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "JUSTIFY" }, "id": "eeeeeeee-5555-4555-8555-eeeeeeeeeeee", "portions": [ { "style": { "fontweight": "BOLD", "size": 12, "color": { "rgb": { "red": 46, "green": 125, "blue": 50 } }, "underline": true, "strike": true, "font_name": { "name": "Open Sans" } }, "text": "Elbow H→K" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "type": "ELBOW", "stroke": { "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 76, "green": 175, "blue": 80 } } } } } }, "id": "22222222-4444-4444-8444-dddddddddddd" }, { "connector": { "connected": { "first": { "marker": "NONE", "shape_id": "C5AFC202-A351-4DD1-A9D8-F0D1A1BDFDD3" }, "second": { "side": "WEST", "marker": "CLASSIC", "shape_id": "A27E27D3-7D11-437C-B006-EE48F3356200" } }, "stroke": { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 244, "green": 67, "blue": 54 } } }, "alpha": 0.75 } } }, "id": "22222222-5555-4555-8555-eeeeeeeeeeee" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, "second": { "marker": "BLOCK", "shape_id": "EFC7A9A1-4294-4560-BD83-C9A8F0EFD3F3" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "aaaaaaaa-1111-4111-8111-aaaaaaaaaaaa", "portions": [ { "style": { "fontweight": "NORMAL", "size": 14, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "A→B" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "stroke": { "width": 1.5, "fill": { "solid": { "color": { "rgb": { "red": 51, "green": 51, "blue": 51 } } }, "alpha": 1 } } }, "id": "11111111-aaaa-4bbb-8ccc-111111111112" }, { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "757F7D65-EDBB-4447-B743-5520B1BA3667" }, "second": { "side": "WEST", "marker": "BLOCK", "shape_id": "FB88F7D0-07E5-4CE9-9FE8-5B24D24A1F54" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "aaaaaaaa-1111-4111-8111-aaaaaaaaaaaa", "portions": [ { "style": { "fontweight": "NORMAL", "size": 14, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "A→B" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "stroke": { "width": 1.5, "fill": { "solid": { "color": { "rgb": { "red": 51, "green": 51, "blue": 51 } } }, "alpha": 1 } } }, "id": "11111111-aaaa-4bbb-8ccc-111111111118" }, { "connector": { "connected": { "first": { "side": "SOUTH", "marker": "NONE", "shape_id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f014" }, "second": { "side": "NORTH", "marker": "BLOCK", "shape_id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f018" } }, "type": "ELBOW", "stroke": { "width": 1.5, "fill": { "solid": { "color": { "rgb": { "red": 13, "green": 71, "blue": 161 } } } } } }, "id": "33333333-1111-4111-8111-aaaaaaaaaaaa" } ] }, "message": "Connectors in frame fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1001", "id": "22222222-1111-4111-8111-aaaaaaaaaaa1", "message": "Element not found" }, { "error_code": "EL1001", "id": "22222222-2222-4222-8222-bbbbbbbbbbbc", "message": "Element not found" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "5777000000915007" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/frames/00000000-0000-0000-0000-000000000000/connectors", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors on Frame" ] }, "delete": { "summary": "Delete one or more connectors from a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteFrameConnectors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "connector_id": "22222222-2222-4222-8222-bbbbbbbbbbbb", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "connector_id": "11111111-aaaa-4bbb-8ccc-111111111118", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Connectors in frame deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "connector_id": "22222222-3333-4333-8333-cccccccccccc", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000001", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000002", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "connector_id": "11111111-aaaa-4bbb-8ccc-111111111112", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Connectors in frame deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken3" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors on Frame" ] }, "put": { "summary": "Update one or more connectors in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutConnectorsRequest" } } } }, "operationId": "updateFrameConnectors", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "22222222-3333-4333-8333-cccccccccccc", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "11111111-aaaa-4bbb-8ccc-111111111112", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "22222222-4444-4444-8444-dddddddddddd", "status": "success" } ] }, "message": "Connectors in frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "22222222-5555-4555-8555-eeeeeeeeeeee", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-4000-8000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "22222222-4444-4444-8444-dddddddddddd", "errors": [ { "error_code": "EL1016", "message": "mutations[0]: Connector 22222222-4444-4444-8444-dddddddddddd has multiple text bodies; only one text body is currently supported.", "facet": "text_mutations" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-4000-8000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "22222222-1111-4111-8111-aaaaaaaaaaaa", "status": "success" } ] }, "message": "Connector in frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } }, "No Facet (Neither properties nor text)": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "items[0].elements[0] must carry at least one of 'properties' or 'text'", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/connectors", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken3" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connectors on Frame" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/frames/{frame_id}/shapes": { "post": { "summary": "Insert one or more shapes into a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShapeInsertRequest" } } } }, "operationId": "createFrameShape", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "shape_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "shape_id": "b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "shape_id": "c3d4e5f6-a7b8-4c9d-be1f-3a4b5c6d7e8f", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "shape_id": "d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "shape_id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Shapes inserted in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "shape_id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f013", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Shapes inserted in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken6" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx4" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes on Frame" ] }, "get": { "summary": "Get the shapes in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getFrameShapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "total_count": 3, "elements": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "f1a2b3c4-d5e6-4a89-b012-c3d4e5f6a7b8", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Rectangle" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 100, "left": 100, "width": 900, "fliph": true, "height": 500 }, "strokes": [ { "jointype": "MITER", "width": 4, "fill": { "solid": { "color": { "hsb": {} } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 40, "green": 10, "blue": 10 } } }, "alpha": 0.2 } ] } } }, "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "e2c3d4e5-f6a7-4b90-ac1d-2e3f4a5b6c7e", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Oval" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 100, "left": 1200, "width": 800, "flipv": true, "height": 500 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "position": "INSIDE", "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 2, "green": 30, "blue": 22 } } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.96, "brightness": 0.18, "hue": 0.43888888 } } }, "alpha": 0.2 } ] } } }, "id": "b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "FIVE_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "f6a7b8c9-d0e1-4f23-bd34-6b7c8d9e0f1a", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "hsb": { "saturation": 0.27, "brightness": 0.95, "hue": 0.6111111 } }, "font_name": { "name": "Open Sans" } }, "text": "Star" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 900, "left": 100, "width": 800, "flipv": true, "fliph": true, "height": 800 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 15, "green": 23, "blue": 42 } } }, "alpha": 0.2 } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.95, "brightness": 0.4, "hue": 0.125 } } }, { "color": { "rgb": { "red": 63, "green": 10, "blue": 10 } }, "position": 1 } ], "type": "RADIAL" }, "alpha": 0.2 } ] } } }, "id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f" } ] }, "message": "Shapes in frame fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 2, "elements": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "f1a2b3c4-d5e6-4a89-b012-c3d4e5f6a7b8", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Rectangle" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 100, "left": 100, "width": 900, "fliph": true, "height": 500 }, "strokes": [ { "jointype": "MITER", "width": 4, "fill": { "solid": { "color": { "hsb": {} } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 40, "green": 10, "blue": 10 } } }, "alpha": 0.2 } ] } } }, "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "e2c3d4e5-f6a7-4b90-ac1d-2e3f4a5b6c7e", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Oval" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 100, "left": 1200, "width": 800, "flipv": true, "height": 500 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "position": "INSIDE", "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 2, "green": 30, "blue": 22 } } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.96, "brightness": 0.18, "hue": 0.43888888 } } }, "alpha": 0.2 } ] } } }, "id": "b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d" } ], "errors": [ { "error_code": "EL1001", "id": "B37069B4-6676-4B1D-9DE8-13BF28854044", "message": "Element not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Default": { "value": { "data": { "total_count": 5, "elements": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "f1a2b3c4-d5e6-4a89-b012-c3d4e5f6a7b8", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Rectangle" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 100, "left": 100, "width": 900, "fliph": true, "height": 500 }, "strokes": [ { "jointype": "MITER", "width": 4, "fill": { "solid": { "color": { "hsb": {} } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 40, "green": 10, "blue": 10 } } }, "alpha": 0.2 } ] } } }, "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "e2c3d4e5-f6a7-4b90-ac1d-2e3f4a5b6c7e", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Oval" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 100, "left": 1200, "width": 800, "flipv": true, "height": 500 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "position": "INSIDE", "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 2, "green": 30, "blue": 22 } } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.96, "brightness": 0.18, "hue": 0.43888888 } } }, "alpha": 0.2 } ] } } }, "id": "b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "ec3d4e5f-a7b8-4c9d-9e1f-3a4b5c6d7e8e", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Triangle" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": { "type": "TRIANGLE", "triangle": {} }, "properties": { "layout": { "top": 100, "left": 2200, "width": 800, "height": 600 }, "strokes": [ { "captype": "SQUARE", "jointype": "BEVEL", "width": 4, "position": "OUTSIDE", "type": "SQUARE_DOT", "fill": { "solid": { "color": { "rgb": { "red": 15, "green": 23, "blue": 42 } } }, "alpha": 0.2 } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.9, "brightness": 0.22, "hue": 0.62222224 } } }, "alpha": 0.2 } ] } } }, "id": "c3d4e5f6-a7b8-4c9d-be1f-3a4b5c6d7e8f" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "d4a5b6c7-d8e9-4f01-a234-5b6c7d8e9f01", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Diamond" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": { "type": "DIAMOND" }, "properties": { "layout": { "top": 100, "left": 3200, "width": 800, "flipv": true, "height": 600 }, "strokes": [ { "jointype": "MITER", "width": 4, "fill": { "solid": { "color": { "hsb": { "saturation": 0.95, "brightness": 0.1, "hue": 0.05 } } }, "alpha": 0.2 } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 124, "green": 45, "blue": 18 } } }, { "color": { "rgb": { "red": 40, "green": 14, "blue": 4 } }, "position": 1 } ] }, "alpha": 0.2 } ] } } }, "id": "d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "FIVE_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "f6a7b8c9-d0e1-4f23-bd34-6b7c8d9e0f1a", "portions": [ { "style": { "fontweight": "BOLD", "size": 28, "color": { "hsb": { "saturation": 0.27, "brightness": 0.95, "hue": 0.6111111 } }, "font_name": { "name": "Open Sans" } }, "text": "Star" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 900, "left": 100, "width": 800, "flipv": true, "fliph": true, "height": 800 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 15, "green": 23, "blue": 42 } } }, "alpha": 0.2 } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.95, "brightness": 0.4, "hue": 0.125 } } }, { "color": { "rgb": { "red": 63, "green": 10, "blue": 10 } }, "position": 1 } ], "type": "RADIAL" }, "alpha": 0.2 } ] } } }, "id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f" } ] }, "message": "Shapes in frame fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1001", "id": "b1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "message": "Element not found" }, { "error_code": "EL1001", "id": "b213d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d", "message": "Element not found" }, { "error_code": "EL1001", "id": "B37069B4-6676-4B1D-9DE8-13BF28854044", "message": "Element not found" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx4" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes on Frame" ] }, "delete": { "summary": "Delete one or more shapes from a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteFrameShapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "shape_id": "d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "shape_id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "shape_id": "64CC53D2-C341-4132-870B-30E516A54BEA", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Shapes in frame deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "shape_id": "F0A055CA-3540-4F70-815C-939AF4E6F612", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "bf55c824-2496-4268-abaf-3ba054bd19ba", "errors": [ { "error_code": "EL1006", "message": "Not a shape" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "bf55c824-2496-4268-abaf-3ba054bd19ba", "errors": [ { "error_code": "EL1006", "message": "Not a shape" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "F0A055CA-3540-4F70-815C-939AF4E6F612", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "shape_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Shapes in frame deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken6" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx4" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes on Frame" ] }, "put": { "summary": "Update one or more shapes in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutShapesRequest" } } } }, "operationId": "updateFrameShapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "c3d4e5f6-a7b8-4c9d-be1f-3a4b5c6d7e8f", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f", "status": "success" } ] }, "message": "Shape in frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "b2c3d4e5-f6a7-4b90-9c1d-2e3f4a5b6c7d", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "7f3e2d1c-9b4a-4e58-a6c7-d8e9f0a1b2c3", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f", "errors": [ { "error_code": "EL1018", "message": "mutations[2]: no new line at index 12", "facet": "text_mutations" } ], "status": "partial" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "7f3e2d1c-9b4a-4e58-a6c7-d8e9f0a1b2c3", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "4a5b6c7d-8e9f-4012-a345-b67c8d9e0f12", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "e5f6a7b8-c9d0-4e12-bd23-5a6b7c8d9e0f", "errors": [ { "error_code": "EL1018", "message": "mutations[2]: No '\\n' at index 11 (cursor_index=12); contract requires cursor_index = N + 1 where text[N] == '\\n'", "facet": "text_mutations" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "status": "success" } ] }, "message": "Shape in frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } }, "No Facet (Neither properties nor text)": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "items[0].elements[0] must carry at least one of 'properties' or 'text'", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/shapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken6" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx4" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes on Frame" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/frames/{frame_id}/text/{text_id}": { "get": { "summary": "Get text of a text-bearing object in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getFrameText", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Default (fetch_type=text, all_text)": { "value": { "data": { "text": "Gem\n\nSilver\n" }, "message": "Text in frame resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "success" } }, "Range text_query": { "value": { "data": { "text": "Gem\n\n" }, "message": "Text in frame resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "success" } }, "fetch_type=length": { "value": { "data": { "length": 12 }, "message": "Text length in frame resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "success" } }, "fetch_type=paragraph_text With text_query": { "value": { "data": { "paragraphs": [ { "paragraph_index": 0, "text": "Gem" }, { "paragraph_index": 1, "text": "" } ] }, "message": "Paragraph text in frame resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "success" } }, "fetch_type=paragraph_count": { "value": { "data": { "paragraph_count": 4 }, "message": "Paragraph count in frame resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Invalid fetch_type": { "value": { "error": { "details": { "error_code": "IAM1036", "attribute": "fetch_type", "message": "The parameter value does not match the required pattern." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Malformed text_query JSON": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1004", "message": "Invalid field value", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/a46f6013-6822-57cf-a71d-4dce016d3123", "status": "error" } } } } } }, "404": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Object": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1001", "message": "Element not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/00000000-0000-0000-0000-000000000000", "status": "error" } }, "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Non-Existent Frame": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1002", "message": "Frame not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/00000000-0000-0000-0000-000000000000/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" }, "501": { "description": "Not implemented - this operation is not available for the requested resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Invalid": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1016", "message": "Not implemented for element type GROUPSHAPE", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/text/BE427379-279A-456E-9AA1-28E125A5B51C", "status": "error" } } } } } } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" }, { "$ref": "#/components/parameters/TextId" }, { "$ref": "#/components/parameters/FetchType" }, { "$ref": "#/components/parameters/TextQuery" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Element Text" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/groupshapes": { "post": { "summary": "Group or ungroup shapes in a zone (op-aware)", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupOpRequest" } } } }, "operationId": "createZoneGroupshape", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Grouping 2": { "value": { "data": { "groups": [ { "group_id": "0f95159c-24f7-4b3d-b7b0-9a080dc9e011", "group_index": 0, "status": "success" }, { "group_id": "18afea79-4ec1-447e-b740-d561a99ec2b0", "group_index": 1, "status": "success" }, { "group_id": "225b1dfc-c5ea-4e61-8928-c973d75811a5", "group_index": 2, "status": "success" }, { "group_id": "390f3d93-0c2a-4f10-869a-590522a4fd44", "group_index": 3, "status": "success" } ] }, "message": "Shapes grouped successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Single Ungrouping": { "value": { "data": { "ungrouped_shape_ids": [ "98FE12D2-A543-4B83-8AC1-172026716501", "D786C7E4-16CE-4E4B-8F70-5C2245D9FEDD", "34C00D67-A6F2-425B-A092-9BA32A21DAAD" ], "results": [ { "id": "1185C86E-6057-4984-85FD-BCD318638E98", "status": "success" } ] }, "message": "Shapes ungrouped successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Failure - Grouping": { "value": { "data": { "errors": [ { "requested_ids": [ "18afea79-4ec1-447e-b740-d561a99ec2b0", "E0DD0833-18B6-4D09-A623-EF518293E06C" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "locked; not groupable", "id": "E0DD0833-18B6-4D09-A623-EF518293E06C" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 0, "eligible_ids": [ "18afea79-4ec1-447e-b740-d561a99ec2b0" ] }, { "requested_ids": [ "34C00D67-A6F2-425B-A092-9BA32A21DAAD", "1C71D627-B12C-41A5-B548-AEA7B580EE84" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "inside group; not groupable", "id": "34C00D67-A6F2-425B-A092-9BA32A21DAAD" }, { "reason": "structure; not groupable", "id": "1C71D627-B12C-41A5-B548-AEA7B580EE84" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 1, "eligible_ids": [] }, { "requested_ids": [ "9E050A2C-618B-409D-A254-2FBE58313FDD", "F5C83D11-D584-4BF0-865E-DC3A1C6D0EC2" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "sticky note; not groupable", "id": "F5C83D11-D584-4BF0-865E-DC3A1C6D0EC2" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 2, "eligible_ids": [ "9E050A2C-618B-409D-A254-2FBE58313FDD" ] }, { "requested_ids": [ "C6BB8636-F9E9-4BD5-B698-CB830FD5DAE4", "15AA157F-CC52-4E4B-80B9-2E4BD6FB2F61" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "table; not groupable", "id": "15AA157F-CC52-4E4B-80B9-2E4BD6FB2F61" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 3, "eligible_ids": [ "C6BB8636-F9E9-4BD5-B698-CB830FD5DAE4" ] }, { "requested_ids": [ "390f3d93-0c2a-4f10-869a-590522a4fd44", "A388778A-6416-42EF-8F64-55FD8ED00DEB" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "inside group; not groupable", "id": "390f3d93-0c2a-4f10-869a-590522a4fd44" }, { "reason": "video placeholder; not groupable", "id": "A388778A-6416-42EF-8F64-55FD8ED00DEB" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 4, "eligible_ids": [] }, { "requested_ids": [ "A8AA0831-99CE-497C-BD1D-4914FD7B358F", "958F416A-ABF8-49BD-8F47-81D84AE5992E" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "table placeholder; not groupable", "id": "958F416A-ABF8-49BD-8F47-81D84AE5992E" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 5, "eligible_ids": [ "A8AA0831-99CE-497C-BD1D-4914FD7B358F" ] }, { "requested_ids": [ "225b1dfc-c5ea-4e61-8928-c973d75811a5", "804EED14-1FCF-4826-AA1F-885D5CA4F9A3" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "inside structure; not groupable", "id": "804EED14-1FCF-4826-AA1F-885D5CA4F9A3" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 6, "eligible_ids": [ "225b1dfc-c5ea-4e61-8928-c973d75811a5" ] }, { "requested_ids": [ "98FE12D2-A543-4B83-8AC1-172026716501" ], "error_code": "EL1018", "message": "At least 2 eligible ids are required for grouping", "group_index": 7, "eligible_ids": [ "98FE12D2-A543-4B83-8AC1-172026716501" ] }, { "requested_ids": [ "D37743BA-D40D-4C46-B515-F1C1FC9571F9", "A30E0B97-F892-4D21-87E0-63961D3C2D6B", "A388778A-6416-42EF-8F64-55FD8ED00DEB", "9E050A2C-618B-409D-A254-2FBE58313FDD" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "inside group; not groupable", "id": "D37743BA-D40D-4C46-B515-F1C1FC9571F9" }, { "reason": "inside group; not groupable", "id": "A30E0B97-F892-4D21-87E0-63961D3C2D6B" }, { "reason": "video placeholder; not groupable", "id": "A388778A-6416-42EF-8F64-55FD8ED00DEB" }, { "reason": "already used in another group", "id": "9E050A2C-618B-409D-A254-2FBE58313FDD" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 8, "eligible_ids": [] } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Single Grouping": { "value": { "data": { "group_id": "a85233de-bdcd-4f14-9e95-63a962fa5bc9", "group_index": 0 }, "message": "Shapes grouped successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Partial Success - Grouping": { "value": { "data": { "groups": [ { "group_id": "146b592a-0fd1-4288-a7e2-1d5059a0d104", "group_index": 0, "status": "success" }, { "group_id": "a33a5fff-53cc-4122-9bce-c24614924cdc", "group_index": 1, "errors": [ { "error_code": "EL1006", "id": "76F1F2DB-390F-4B97-9310-8816A00FBB88", "message": "GRAPHICFRAME of type WIDGET is not groupable" } ], "status": "partial" } ], "errors": [ { "requested_ids": [ "12781BA1-0B14-4B50-9BA6-F898E63A0C0B", "00000000-0000-0000-0000-000000000000", "4A04B0C1-E2EA-42AC-BE68-431D27AFB7D2" ], "error_code": "EL1018", "ineligible_reasons": [ { "reason": "element not found", "id": "00000000-0000-0000-0000-000000000000" }, { "reason": "already used in another group", "id": "4A04B0C1-E2EA-42AC-BE68-431D27AFB7D2" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 2, "eligible_ids": [ "12781BA1-0B14-4B50-9BA6-F898E63A0C0B" ] } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Multiple Grouping": { "value": { "data": { "groups": [ { "group_id": "0f95159c-24f7-4b3d-b7b0-9a080dc9e011", "group_index": 0, "status": "success" }, { "group_id": "18afea79-4ec1-447e-b740-d561a99ec2b0", "group_index": 1, "status": "success" }, { "group_id": "225b1dfc-c5ea-4e61-8928-c973d75811a5", "group_index": 2, "status": "success" }, { "group_id": "390f3d93-0c2a-4f10-869a-590522a4fd44", "group_index": 3, "status": "success" } ] }, "message": "Shapes grouped successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Multiple Ungrouping": { "value": { "data": { "ungrouped_shape_ids": [ "98FE12D2-A543-4B83-8AC1-172026716501", "D786C7E4-16CE-4E4B-8F70-5C2245D9FEDD", "34C00D67-A6F2-425B-A092-9BA32A21DAAD", "22B0D2F5-C86E-4C1F-A88C-F44C26AFEE9C", "7E4CCC6E-D8F4-4A7C-A1B8-593DE3D4C9E7", "35C6DB02-F32C-443A-81EB-5D43E8021B8B", "77E4DF34-EB21-4F65-B75B-C1E447A12A7A", "05F382AB-F890-4823-81D3-510B0DE675AE" ], "results": [ { "id": "139FBFCF-13E5-48AE-9DD7-0FAC5E8EE671", "status": "success" }, { "id": "E97E3C51-84C4-4626-95AB-AABEA4C08EC2", "status": "success" }, { "id": "53445a56-14eb-4332-8a3a-0dc71e2f0cfe", "status": "success" } ] }, "message": "Shapes ungrouped successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Partial Success - Ungrouping": { "value": { "data": { "ungrouped_shape_ids": [ "22B0D2F5-C86E-4C1F-A88C-F44C26AFEE9C", "7E4CCC6E-D8F4-4A7C-A1B8-593DE3D4C9E7" ], "results": [ { "id": "31B75777-3770-46CF-A967-8403753B8276", "status": "success" } ], "errors": [ { "error_code": "EL1001", "id": "00000000-0000-0000-0000-000000000000", "message": "Element not found" }, { "error_code": "EL1006", "id": "E0DD0833-18B6-4D09-A623-EF518293E06C", "message": "Not a groupshape" }, { "error_code": "EL1018", "id": "31B75777-3770-46CF-A967-8403753B8276", "message": "id appears more than once" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Failure - Ungrouping": { "value": { "data": { "errors": [ { "error_code": "EL1001", "id": "00000000-0000-0000-0000-000000000000", "message": "Element not found" }, { "error_code": "EL1006", "id": "E0DD0833-18B6-4D09-A623-EF518293E06C", "message": "Not a groupshape" }, { "error_code": "EL1006", "id": "F5C83D11-D584-4BF0-865E-DC3A1C6D0EC2", "message": "specialised STICKYNOTE container cannot be ungrouped" }, { "error_code": "EL1006", "id": "1C71D627-B12C-41A5-B548-AEA7B580EE84", "message": "specialised STRUCTURE container cannot be ungrouped" }, { "error_code": "EL1006", "id": "804EED14-1FCF-4826-AA1F-885D5CA4F9A3", "message": "inside STRUCTURE container cannot be ungrouped" }, { "error_code": "EL1006", "id": "24523A12-39F2-49B9-9BFE-AED0E4F911F0", "message": "inside GROUPSHAPE container cannot be ungrouped" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/C1886757-1B63-4281-A6B7-B478147210EB/groupshapes", "status": "error" } }, "Missing 'op' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "op", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/C1886757-1B63-4281-A6B7-B478147210EB/groupshapes", "status": "error" } }, "Empty 'groups' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "groups", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes", "status": "error" } }, "Invalid Request": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "Provide exactly one of 'groups' or 'nested_groups', not both", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/C1886757-1B63-4281-A6B7-B478147210EB/groupshapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/groupshapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "op", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/C1886757-1B63-4281-A6B7-B478147210EB/groupshapes", "status": "error" } }, "Missing 'groups' Field": { "value": { "error": { "details": { "error_code": "EL1018", "message": "Provide 'nested_groups' for op=group or 'groups' for op=ungroup" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes", "status": "error" } }, "Invalid 'op' Value": { "value": { "error": { "details": { "error_code": "IAM1036", "attribute": "op", "message": "The parameter value does not match the required pattern." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/C1886757-1B63-4281-A6B7-B478147210EB/groupshapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken7" }, "404": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/groupshapes", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/groupshapes", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes" ] }, "get": { "summary": "Get the group shapes in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZoneGroupshapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "total_count": 3, "elements": [ { "group_shape": { "layout": { "top": -1703, "left": 619, "width": 1054.31, "height": 1168.577 }, "objects": [ { "group_shape": { "layout": { "top": -389.62683, "left": 646.5, "width": 822.5403, "height": 544.8257 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -181, "left": 646.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9B379582-B285-47D2-BF41-DD76EF9FE958" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "5134DB4A-26F3-4CDE-BDF6-D8137DF237F6", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -389.62683, "left": 938.52606, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.65432, "brightness": 0.95294, "hue": 0.0283 } }, "position": 0.0581 }, { "color": { "hsb": { "saturation": 0.51479, "brightness": 0.66275, "hue": 0.48659 } }, "position": 0.9538 } ], "type": "RADIAL" } } ] } } }, "id": "CC9425EB-D2F8-4439-8303-1CA336058EFB" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "SEVEN_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "9E2F0822-8E97-47E9-BB92-58A0F0BD421C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "start" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 30.198849, "left": 1344.0403, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "FF0024A2-785E-464D-84CA-36BB1FBB9786" } ] }, "id": "35C6DB02-F32C-443A-81EB-5D43E8021B8B" }, { "shape": { "shape": { "callout": { "type": "CLOUD_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "BE56BD69-C330-489A-B98E-7CB175FFBD23", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 396.26172, "left": 1048.8867, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "77E4DF34-EB21-4F65-B75B-C1E447A12A7A" }, { "shape": { "shape": { "star": { "ribbon": { "type": "DOWN" }, "type": "RIBBON" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "14C9561F-A2E9-473B-96CC-6382D957AC66", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 653.9501, "left": 1575.8098, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "05F382AB-F890-4823-81D3-510B0DE675AE" } ] }, "id": "18afea79-4ec1-447e-b740-d561a99ec2b0" }, { "group_shape": { "layout": { "top": 945, "left": 1234, "width": 1193.688, "height": 996.707 }, "objects": [ { "group_shape": { "layout": { "top": 953.56714, "left": 828.33813, "width": 383.9535, "height": 133.41003 }, "objects": [ { "shape": { "shape": { "mathematical_symbol": { "type": "MULTIPLY" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "43965B02-6A77-49A8-8FE3-B99BE06178C8", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 953.56714, "left": 1087.2916, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.44715, "brightness": 0.96471, "hue": 0.87273 } } } } ] } } }, "id": "5D923685-27EE-4905-8815-C16F1D8A8DCC" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "99D88FE8-CE11-4894-BFA6-D08D70ABE4E4", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 961.9772, "left": 828.33813, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "EEBB15FC-D5CD-47B5-8B0C-9B765616B4B9" } ] }, "id": "CBFE9913-4D10-486A-80F9-03D160C2C6A5" }, { "shape": { "shape": { "flowchart": { "type": "INTERNAL_STORAGE" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "6403E8B7-B380-42DF-8588-F480DA2BED8F", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 1244.6555, "left": 505.62988, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "6176DD11-BC4E-47A5-81AC-3EE7CCD5EDE6" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FBFEBFF7-F671-45C8-A5CC-8A7DC4A51780", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "CLOUD" }, "properties": { "layout": { "top": 1006.0866, "left": 1450.2146, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.07653, "brightness": 0.76863, "hue": 0.61111 } } } } ] } } }, "id": "62B4990B-D8FB-43D8-A135-726E3A37959C" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "A60696AF-9992-40D2-A24C-6353402C9C2C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "HEART" }, "properties": { "layout": { "top": 372.94846, "left": 1574.3179, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.93088, "brightness": 0.85098 } } } } ] } } }, "id": "6F518490-1979-4AB6-8700-DFE27480826D" } ] }, "id": "225b1dfc-c5ea-4e61-8928-c973d75811a5" }, { "group_shape": { "layout": { "top": -389.62683, "left": 646.5, "width": 822.5403, "height": 544.8257 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -181, "left": 646.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9B379582-B285-47D2-BF41-DD76EF9FE958" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "5134DB4A-26F3-4CDE-BDF6-D8137DF237F6", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -389.62683, "left": 938.52606, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.65432, "brightness": 0.95294, "hue": 0.0283 } }, "position": 0.0581 }, { "color": { "hsb": { "saturation": 0.51479, "brightness": 0.66275, "hue": 0.48659 } }, "position": 0.9538 } ], "type": "RADIAL" } } ] } } }, "id": "CC9425EB-D2F8-4439-8303-1CA336058EFB" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "SEVEN_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "9E2F0822-8E97-47E9-BB92-58A0F0BD421C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "start" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 30.198849, "left": 1344.0403, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "FF0024A2-785E-464D-84CA-36BB1FBB9786" } ] }, "id": "35C6DB02-F32C-443A-81EB-5D43E8021B8B" } ] }, "message": "GroupShapes fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 1, "elements": [ { "group_shape": { "layout": { "top": -1703, "left": 619, "width": 1054.31, "height": 1168.577 }, "objects": [ { "group_shape": { "layout": { "top": -389.62683, "left": 646.5, "width": 822.5403, "height": 544.8257 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -181, "left": 646.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9B379582-B285-47D2-BF41-DD76EF9FE958" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "5134DB4A-26F3-4CDE-BDF6-D8137DF237F6", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -389.62683, "left": 938.52606, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.65432, "brightness": 0.95294, "hue": 0.0283 } }, "position": 0.0581 }, { "color": { "hsb": { "saturation": 0.51479, "brightness": 0.66275, "hue": 0.48659 } }, "position": 0.9538 } ], "type": "RADIAL" } } ] } } }, "id": "CC9425EB-D2F8-4439-8303-1CA336058EFB" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "SEVEN_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "9E2F0822-8E97-47E9-BB92-58A0F0BD421C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "start" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 30.198849, "left": 1344.0403, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "FF0024A2-785E-464D-84CA-36BB1FBB9786" } ] }, "id": "35C6DB02-F32C-443A-81EB-5D43E8021B8B" }, { "shape": { "shape": { "callout": { "type": "CLOUD_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "BE56BD69-C330-489A-B98E-7CB175FFBD23", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 396.26172, "left": 1048.8867, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "77E4DF34-EB21-4F65-B75B-C1E447A12A7A" }, { "shape": { "shape": { "star": { "ribbon": { "type": "DOWN" }, "type": "RIBBON" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "14C9561F-A2E9-473B-96CC-6382D957AC66", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 653.9501, "left": 1575.8098, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "05F382AB-F890-4823-81D3-510B0DE675AE" } ] }, "id": "18afea79-4ec1-447e-b740-d561a99ec2b0" } ], "errors": [ { "error_code": "EL1006", "id": "F5C83D11-D584-4BF0-865E-DC3A1C6D0EC2", "message": "specialised STICKYNOTE container is not a groupshape" }, { "error_code": "EL1006", "id": "E0DD0833-18B6-4D09-A623-EF518293E06C", "message": "Not a groupshape" }, { "error_code": "EL1001", "id": "00000000-0000-0000-0000-000000000000", "message": "Element not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Default": { "value": { "data": { "total_count": 10, "elements": [ { "group_shape": { "layout": { "top": -1703, "left": 619, "width": 1054.31, "height": 1168.577 }, "objects": [ { "group_shape": { "layout": { "top": -389.62683, "left": 646.5, "width": 822.5403, "height": 544.8257 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -181, "left": 646.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9B379582-B285-47D2-BF41-DD76EF9FE958" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "5134DB4A-26F3-4CDE-BDF6-D8137DF237F6", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -389.62683, "left": 938.52606, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.65432, "brightness": 0.95294, "hue": 0.0283 } }, "position": 0.0581 }, { "color": { "hsb": { "saturation": 0.51479, "brightness": 0.66275, "hue": 0.48659 } }, "position": 0.9538 } ], "type": "RADIAL" } } ] } } }, "id": "CC9425EB-D2F8-4439-8303-1CA336058EFB" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "SEVEN_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "9E2F0822-8E97-47E9-BB92-58A0F0BD421C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "start" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 30.198849, "left": 1344.0403, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "FF0024A2-785E-464D-84CA-36BB1FBB9786" } ] }, "id": "35C6DB02-F32C-443A-81EB-5D43E8021B8B" }, { "shape": { "shape": { "callout": { "type": "CLOUD_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "BE56BD69-C330-489A-B98E-7CB175FFBD23", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 396.26172, "left": 1048.8867, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "77E4DF34-EB21-4F65-B75B-C1E447A12A7A" }, { "shape": { "shape": { "star": { "ribbon": { "type": "DOWN" }, "type": "RIBBON" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "14C9561F-A2E9-473B-96CC-6382D957AC66", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 653.9501, "left": 1575.8098, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "05F382AB-F890-4823-81D3-510B0DE675AE" } ] }, "id": "18afea79-4ec1-447e-b740-d561a99ec2b0" }, { "group_shape": { "layout": { "top": 945, "left": 1234, "width": 1193.688, "height": 996.707 }, "objects": [ { "group_shape": { "layout": { "top": 953.56714, "left": 828.33813, "width": 383.9535, "height": 133.41003 }, "objects": [ { "shape": { "shape": { "mathematical_symbol": { "type": "MULTIPLY" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "43965B02-6A77-49A8-8FE3-B99BE06178C8", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 953.56714, "left": 1087.2916, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.44715, "brightness": 0.96471, "hue": 0.87273 } } } } ] } } }, "id": "5D923685-27EE-4905-8815-C16F1D8A8DCC" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "99D88FE8-CE11-4894-BFA6-D08D70ABE4E4", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 961.9772, "left": 828.33813, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "EEBB15FC-D5CD-47B5-8B0C-9B765616B4B9" } ] }, "id": "CBFE9913-4D10-486A-80F9-03D160C2C6A5" }, { "shape": { "shape": { "flowchart": { "type": "INTERNAL_STORAGE" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "6403E8B7-B380-42DF-8588-F480DA2BED8F", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 1244.6555, "left": 505.62988, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "6176DD11-BC4E-47A5-81AC-3EE7CCD5EDE6" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FBFEBFF7-F671-45C8-A5CC-8A7DC4A51780", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "CLOUD" }, "properties": { "layout": { "top": 1006.0866, "left": 1450.2146, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.07653, "brightness": 0.76863, "hue": 0.61111 } } } } ] } } }, "id": "62B4990B-D8FB-43D8-A135-726E3A37959C" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "A60696AF-9992-40D2-A24C-6353402C9C2C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "HEART" }, "properties": { "layout": { "top": 372.94846, "left": 1574.3179, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.93088, "brightness": 0.85098 } } } } ] } } }, "id": "6F518490-1979-4AB6-8700-DFE27480826D" } ] }, "id": "225b1dfc-c5ea-4e61-8928-c973d75811a5" }, { "group_shape": { "layout": { "top": 793.4381, "left": -1288.5576, "width": 298, "height": 298 }, "objects": [ { "group_shape": { "layout": { "top": 637.43335, "left": 7867.1577, "width": 125, "height": 125 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "EA992B5E-06F4-42CD-9C40-23F07334A068", "portions": [ { "style": {} } ] } ], "properties": {} }, "basic": {}, "properties": { "layout": { "top": 6721, "left": 29378.691, "width": 450, "height": 450 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "no_fill": {} } } ], "fills": [ { "solid": { "color": { "hsb": {} } } } ] } } }, "id": "D8111073-AE47-441F-8901-2BF280E4BB2B" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "021FA3D1-F99E-449D-B798-182C41317CC0", "portions": [ { "style": {} } ] } ], "properties": {} }, "basic": {}, "properties": { "layout": { "top": 6784.2295, "left": 29441.922, "width": 323.53998, "height": 323.53998 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "no_fill": {} } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "CC3EB412-943E-450A-BCE8-0016706E15B9" } ] }, "id": "2F194D64-5BAF-40DB-A4FE-2FC92EBE2015" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.1 }, "level": 1, "halign": "CENTER" }, "id": "391849C1-9CD7-408C-9582-482483B7B35D", "portions": [ { "style": { "size": 14, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Ethernet port" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "valign": "TOP" } }, "basic": {}, "properties": { "layout": { "top": 691.0992, "left": 7867.1577, "width": 125, "height": 59.26599 }, "strokes": [ { "jointype": "MITER", "width": 2, "fill": { "no_fill": {} } } ], "fills": [ { "no_fill": {} } ] } } }, "id": "A43B00EE-CB1D-485E-95E1-2E447F7CD32A" } ] }, "id": "C6BB8636-F9E9-4BD5-B698-CB830FD5DAE4" }, { "group_shape": { "layout": { "top": 1606.4008, "left": 576.8109, "width": 1193.688, "height": 996.707 }, "objects": [ { "group_shape": { "layout": { "top": 953.56714, "left": 828.33813, "width": 383.9535, "height": 133.41003 }, "objects": [ { "shape": { "shape": { "mathematical_symbol": { "type": "MULTIPLY" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "43965B02-6A77-49A8-8FE3-B99BE06178C8", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 953.56714, "left": 1087.2916, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.44715, "brightness": 0.96471, "hue": 0.87273 } } } } ] } } }, "id": "5D923685-27EE-4905-8815-C16F1D8A8DCC" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "99D88FE8-CE11-4894-BFA6-D08D70ABE4E4", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 961.9772, "left": 828.33813, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "EEBB15FC-D5CD-47B5-8B0C-9B765616B4B9" } ] }, "id": "CBFE9913-4D10-486A-80F9-03D160C2C6A5" }, { "shape": { "shape": { "flowchart": { "type": "INTERNAL_STORAGE" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "6403E8B7-B380-42DF-8588-F480DA2BED8F", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 1244.6555, "left": 505.62988, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "6176DD11-BC4E-47A5-81AC-3EE7CCD5EDE6" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FBFEBFF7-F671-45C8-A5CC-8A7DC4A51780", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "CLOUD" }, "properties": { "layout": { "top": 1006.0866, "left": 1450.2146, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.07653, "brightness": 0.76863, "hue": 0.61111 } } } } ] } } }, "id": "62B4990B-D8FB-43D8-A135-726E3A37959C" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "A60696AF-9992-40D2-A24C-6353402C9C2C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "HEART" }, "properties": { "layout": { "top": 372.94846, "left": 1574.3179, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.93088, "brightness": 0.85098 } } } } ] } } }, "id": "6F518490-1979-4AB6-8700-DFE27480826D" } ] }, "id": "8f785bea-4832-4aef-9798-e9c7f5bbf6dd" }, { "group_shape": { "layout": { "top": -3379, "left": -3169.5334, "width": 1786.074, "height": 2536.893 }, "objects": [ { "group_shape": { "layout": { "top": -2399, "left": -4854, "width": 1300.9939, "height": 1507.8931 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "portions": [ { "style": {} } ] } ], "properties": {} }, "basic": {}, "properties": { "layout": { "top": -1276.2114, "left": -1503, "width": 560, "height": 315 }, "fills": [ {} ] } } }, "id": "D37743BA-D40D-4C46-B515-F1C1FC9571F9" }, { "group_shape": { "layout": { "top": -2469.1045, "left": -2243.9934, "width": 499.48376, "height": 1218.0002 }, "objects": [ { "group_shape": { "layout": { "top": 318, "left": 569, "width": 367.6479, "height": 332.64124 }, "objects": [ { "group_shape": { "layout": { "top": 311, "left": 569, "width": 280, "height": 125 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "D395EB0D-2A79-4E5C-AF7D-BC2078EF577B", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "ghg" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "rounded_rectangle": {}, "type": "ROUNDED_RECTANGLE" }, "properties": { "layout": { "top": 309.5, "left": 723.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "189B56C1-9056-4BCB-8C85-44F857846D4C" }, { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "BF702DD4-E400-48A9-9B7F-B41B1EE2FA25", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 309.5, "left": 568.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "C06EF41B-B11F-4560-8F84-35E922626E16" } ] }, "id": "f83685e6-7921-4bb4-8515-8afdebcb2c83" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "93DBC961-E894-4C29-AB33-6789A91FBCE8", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 518.641, "left": 811.6476, "width": 124.99995, "height": 124.99991 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "3756582C-7263-4B3B-9CF6-38B5CB0C29A6" } ] }, "id": "0f95159c-24f7-4b3d-b7b0-9a080dc9e011" }, { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "D2C4E311-061B-4DC1-AC96-9B2D56334CB2", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": -567.359, "left": 437.1636, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "A30E0B97-F892-4D21-87E0-63961D3C2D6B" } ] }, "id": "1d070195-95f1-4178-9204-5ec1b4b31bff" } ] }, "id": "6d64da01-1dc2-45f4-83e3-e80595abe453" }, { "shape": { "shape": { "block_arrow": { "single_arrow": {} }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "4DDE417C-C466-41F0-878F-2DB9A4E671A0", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": -3428, "left": -3192.9258, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "4A04B0C1-E2EA-42AC-BE68-431D27AFB7D2" } ] }, "id": "146b592a-0fd1-4288-a7e2-1d5059a0d104" }, { "group_shape": { "layout": { "top": 5361.5996, "left": -667.9464, "width": 306, "height": 252 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "5DF36054-4F23-41D9-BFCF-137441B03465", "portions": [ { "style": { "color": { "hsb": {} } } } ] } ], "properties": { "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 3793.8408, "left": 13913.897, "width": 306, "height": 252 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "no_fill": {} } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.70213, "brightness": 0.92157, "hue": 0.00101 } } } } ] } } }, "id": "BECA8B44-8FD1-4739-B735-98A3202E32D1" }, { "group_shape": { "layout": { "top": 3833.804, "left": 13918.364, "width": 297.0665, "height": 172.07352 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "F7ECF15E-EA88-4115-B1BD-AF6CC67215B6", "portions": [ { "style": { "fontweight": "NORMAL", "size": 140, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Monoton" } }, "text": "4" }, { "style": { "fontweight": "NORMAL", "size": 120, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Monoton" } }, "text": "0" }, { "style": { "fontweight": "NORMAL", "size": 140, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Monoton" } }, "text": "4" } ] } ], "properties": { "inset": {}, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 1133.0237, "left": 798.3219, "width": 387.26627, "height": 197.81024 }, "strokes": [ { "jointype": "MITER", "width": 1, "type": "DASH", "fill": { "no_fill": {} } } ] } } }, "id": "80384FB7-772E-4BA2-9386-071AC444E0D2" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "F7ECF15E-EA88-4115-B1BD-AF6CC67215B6", "portions": [ { "style": { "fontweight": "BOLD", "size": 24, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Doppio One" } }, "text": "NOT FOUND" } ] } ], "properties": { "inset": {}, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 1106.5134, "left": 893.95215, "width": 204.62093, "height": 38.70681 }, "strokes": [ { "jointype": "MITER", "width": 1, "type": "DASH", "fill": { "no_fill": {} } } ] } } }, "id": "2054E8B0-745F-471F-B33F-609FDD9A8EF2" } ] }, "id": "ED3796A4-978C-4EE0-BC28-C0AB4831A7F3" } ] }, "id": "7CA53CEA-9037-482D-9317-21EB1BD7DFA5" }, { "group_shape": { "layout": { "top": 1998.3287, "left": -719, "width": 305.99997, "height": 252.00015 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "halign": "CENTER" }, "id": "5DF36054-4F23-41D9-BFCF-137441B03465", "portions": [ { "style": { "color": { "hsb": {} } } } ] } ], "properties": { "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 3793.8408, "left": 13913.897, "width": 306, "height": 252 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "no_fill": {} } } ], "fills": [ { "solid": { "color": { "hsb": { "saturation": 0.70213, "brightness": 0.92157, "hue": 0.00101 } } } } ] } } }, "id": "BECA8B44-8FD1-4739-B735-98A3202E32D1" }, { "group_shape": { "layout": { "top": 3833.804, "left": 13918.364, "width": 297.0665, "height": 172.07352 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "F7ECF15E-EA88-4115-B1BD-AF6CC67215B6", "portions": [ { "style": { "fontweight": "NORMAL", "size": 140, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Monoton" } }, "text": "4" }, { "style": { "fontweight": "NORMAL", "size": 120, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Monoton" } }, "text": "0" }, { "style": { "fontweight": "NORMAL", "size": 140, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Monoton" } }, "text": "4" } ] } ], "properties": { "inset": {}, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 1133.0237, "left": 798.3219, "width": 387.26627, "height": 197.81024 }, "strokes": [ { "jointype": "MITER", "width": 1, "type": "DASH", "fill": { "no_fill": {} } } ] } } }, "id": "80384FB7-772E-4BA2-9386-071AC444E0D2" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "F7ECF15E-EA88-4115-B1BD-AF6CC67215B6", "portions": [ { "style": { "fontweight": "BOLD", "size": 24, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Doppio One" } }, "text": "NOT FOUND" } ] } ], "properties": { "inset": {}, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 1106.5134, "left": 893.95215, "width": 204.62093, "height": 38.70681 }, "strokes": [ { "jointype": "MITER", "width": 1, "type": "DASH", "fill": { "no_fill": {} } } ] } } }, "id": "2054E8B0-745F-471F-B33F-609FDD9A8EF2" } ] }, "id": "ED3796A4-978C-4EE0-BC28-C0AB4831A7F3" } ] }, "id": "7CA53CEA-9037-482D-9317-21EB1BD7DFA5" }, { "group_shape": { "layout": { "top": 3430.5586, "left": 868.115, "width": 902.3839, "height": 989.4414 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "411BF5F4-9638-4387-8F0F-FA4E23101E2D", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "TRIANGLE", "triangle": {} }, "properties": { "layout": { "top": 3771.4792, "left": 1462.8989, "width": 307.6, "height": 307.6 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "98FE12D2-A543-4B83-8AC1-172026716501" }, { "group_shape": { "layout": { "top": 3430.5586, "left": 868.115, "width": 125, "height": 989.4414 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "50E09D78-DC95-4F5F-B943-D4B611BD4531", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "DIAMOND" }, "properties": { "layout": { "top": 3430.5586, "left": 868.115, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "22B0D2F5-C86E-4C1F-A88C-F44C26AFEE9C" }, { "shape": { "shape": { "block_arrow": { "single_arrow": {} }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "7CD6E69B-218C-4355-9C9D-AF98F35B13B2", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 4295, "left": 868.115, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "7E4CCC6E-D8F4-4A7C-A1B8-593DE3D4C9E7" } ] }, "id": "24523A12-39F2-49B9-9BFE-AED0E4F911F0" } ] }, "id": "B632BF62-C8A9-4380-BB78-79EA7983A5EB" }, { "group_shape": { "layout": { "top": -389.62683, "left": 646.5, "width": 822.5403, "height": 544.8257 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "FCE56BCB-D8FB-4FBC-B189-72BF17DA39EC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -181, "left": 646.5, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9B379582-B285-47D2-BF41-DD76EF9FE958" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "5134DB4A-26F3-4CDE-BDF6-D8137DF237F6", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -389.62683, "left": 938.52606, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "hsb": { "saturation": 0.65432, "brightness": 0.95294, "hue": 0.0283 } }, "position": 0.0581 }, { "color": { "hsb": { "saturation": 0.51479, "brightness": 0.66275, "hue": 0.48659 } }, "position": 0.9538 } ], "type": "RADIAL" } } ] } } }, "id": "CC9425EB-D2F8-4439-8303-1CA336058EFB" }, { "shape": { "shape": { "star": { "type": "POINT", "point": { "type": "SEVEN_POINT" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "9E2F0822-8E97-47E9-BB92-58A0F0BD421C", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "start" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 30.198849, "left": 1344.0403, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "FF0024A2-785E-464D-84CA-36BB1FBB9786" } ] }, "id": "35C6DB02-F32C-443A-81EB-5D43E8021B8B" }, { "group_shape": { "layout": { "top": 3899.1548, "left": -306.55453, "width": 796.5547, "height": 436.8452 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "48D395A0-B959-4BB2-82B8-DD2FE6A8A55F", "portions": [ { "style": { "size": 16, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Process" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 4086, "left": 240.00015, "width": 250, "height": 250 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": {} } } } } ], "fills": [ { "no_fill": {} } ] } } }, "id": "34C00D67-A6F2-425B-A092-9BA32A21DAAD" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1 }, "level": 1, "halign": "CENTER" }, "id": "720DCD75-4B1B-4189-BAD9-ECD5F9182FDE", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "SUN" }, "properties": { "layout": { "top": 3899.1548, "left": -306.55453, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "D786C7E4-16CE-4E4B-8F70-5C2245D9FEDD" } ] }, "id": "292b0974-d0f9-4010-9a39-e13a2b0c6740" } ] }, "message": "GroupShapes fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1006", "id": "24523A12-39F2-49B9-9BFE-AED0E4F911F0", "message": "inside GROUPSHAPE container is not a groupshape" }, { "error_code": "EL1006", "id": "804EED14-1FCF-4826-AA1F-885D5CA4F9A3", "message": "inside STRUCTURE container is not a groupshape" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/groupshapes", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/groupshapes", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx8" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes" ] }, "delete": { "summary": "Delete one or more group shapes in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteZoneGroupshapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "shape_id": "F0C973CE-B8A1-4117-B04A-7711FE6A020C", "status": "success" }, { "shape_id": "BBCDD65F-C6BF-4D73-ACF9-FBB4608A444C", "status": "success" }, { "shape_id": "89EC067F-EAEF-419A-B800-88045B81663F", "status": "success" } ] }, "message": "Group shapes deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "shape_id": "0F183419-5235-4F44-A786-C32C5C9B3C23", "status": "success" }, { "id": "E0DD0833-18B6-4D09-A623-EF518293E06C", "errors": [ { "error_code": "EL1006", "message": "Not a groupshape" } ], "status": "failed" }, { "id": "1E4D324C-A9E9-41AC-9F53-57538F2BA611", "errors": [ { "error_code": "EL1006", "message": "specialised STICKYNOTE container is not a groupshape" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "1C71D627-B12C-41A5-B548-AEA7B580EE84", "errors": [ { "error_code": "EL1006", "message": "specialised STRUCTURE container is not a groupshape" } ], "status": "failed" }, { "id": "CBFE9913-4D10-486A-80F9-03D160C2C6A5", "errors": [ { "error_code": "EL1006", "message": "inside GROUPSHAPE container is not a groupshape" } ], "status": "failed" }, { "id": "804EED14-1FCF-4826-AA1F-885D5CA4F9A3", "errors": [ { "error_code": "EL1006", "message": "inside STRUCTURE container is not a groupshape" } ], "status": "failed" }, { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "shape_id": "8F28ED4F-69BB-49B2-81CE-D33E323892C8", "status": "success" } ] }, "message": "Group shapes deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes", "status": "error" } }, "Empty 'groups' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/groupshapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/groupshapes", "status": "error" } }, "Missing 'groups' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken7" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx8" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes" ] }, "put": { "summary": "Update one or more group shapes in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutGroupShapesRequest" } } } }, "operationId": "updateZoneGroupshapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "results": [ { "id": "E0DD0833-18B6-4D09-A623-EF518293E06C", "errors": [ { "error_code": "EL1006", "message": "Not a groupshape", "facet": "element" } ], "status": "failed" }, { "id": "F5C83D11-D584-4BF0-865E-DC3A1C6D0EC2", "errors": [ { "error_code": "EL1006", "message": "specialised STICKYNOTE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "id": "8F28ED4F-69BB-49B2-81CE-D33E323892C8", "status": "success" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Multiple Element": { "value": { "data": { "results": [ { "id": "B632BF62-C8A9-4380-BB78-79EA7983A5EB", "status": "success" }, { "id": "8f785bea-4832-4aef-9798-e9c7f5bbf6dd", "status": "success" }, { "id": "8F28ED4F-69BB-49B2-81CE-D33E323892C8", "status": "success" } ] }, "message": "Group shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "1C71D627-B12C-41A5-B548-AEA7B580EE84", "errors": [ { "error_code": "EL1006", "message": "specialised STRUCTURE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "id": "CBFE9913-4D10-486A-80F9-03D160C2C6A5", "errors": [ { "error_code": "EL1006", "message": "inside GROUPSHAPE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "id": "804EED14-1FCF-4826-AA1F-885D5CA4F9A3", "errors": [ { "error_code": "EL1006", "message": "inside STRUCTURE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "id": "B632BF62-C8A9-4380-BB78-79EA7983A5EB", "status": "success" } ] }, "message": "Group shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/groupshapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } }, "No Facet": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "elements[0] must carry 'properties.layout' for group shape update", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/groupshapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken7" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx8" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/frames/{frame_id}/frames": { "post": { "summary": "Insert one or more child frames into a parent frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrameInsertRequest" } } } }, "operationId": "createFrameFrame", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Frames": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "frame_id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "frame_id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "frame_id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "frame_id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "frame_id": "74b0dfa1-9186-5290-a16c-89b51db3bd31", "status": "success" } ] }, "message": "Nested frames inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/E51ABCEF-C5A5-42D1-8686-9A6307E4B73A/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "success" } }, "Single Frame": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "frame_id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a03", "status": "success" } ] }, "message": "Nested frames inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/E51ABCEF-C5A5-42D1-8686-9A6307E4B73A/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Missing 'frames' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "frames", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "meta", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Empty 'frames' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "frames", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken4" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx2" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames on Frame" ] }, "get": { "summary": "Get the child frames of a parent frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getFrameFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "frames": [ { "meta": { "name": "Single Child Frame", "id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a03" }, "type": "CUSTOM", "properties": { "layout": { "top": 320, "left": 200, "width": 640, "height": 360 }, "strokes": [ { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 204, "green": 204, "blue": 204 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 245, "green": 245, "blue": 250 } } } } ] } }, { "meta": { "name": "Child A4", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "width": 794, "height": 1123 }, "strokes": [ { "jointype": "MITER", "width": 1, "position": "INSIDE", "fill": { "solid": { "color": { "hsb": { "saturation": 0.85, "brightness": 0.25, "hue": 0.0016975309 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } }, { "color": { "rgb": { "red": 229, "green": 231, "blue": 235 } }, "position": 1 } ], "type": "RADIAL" } } ] } }, { "meta": { "name": "Child Custom", "id": "74b0dfa1-9186-5290-a16c-89b51db3bd31" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "left": 1400, "width": 600, "height": 800 }, "strokes": [ { "captype": "SQUARE", "width": 2, "position": "OUTSIDE", "type": "SQUARE_DOT", "fill": { "solid": { "color": { "hsb": { "saturation": 0.7, "brightness": 0.65, "hue": 0.0023148148 } } } } } ], "fills": [ { "no_fill": {} } ] } } ], "total_count": 3 }, "message": "Nested frames fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Partial Success": { "value": { "data": { "frames": [ { "meta": { "name": "Single Child Frame", "id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a03" }, "type": "CUSTOM", "properties": { "layout": { "top": 320, "left": 200, "width": 640, "height": 360 }, "strokes": [ { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 204, "green": 204, "blue": 204 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 245, "green": 245, "blue": 250 } } } } ] } } ], "total_count": 1, "errors": [ { "error_code": "EL1002", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f29", "message": "Frame not found" }, { "error_code": "EL1002", "id": "74b0dfa1-9186-5290-a16c-89b51db3bd32", "message": "Frame not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Default": { "value": { "data": { "frames": [ { "meta": { "name": "Single Child Frame", "id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a03" }, "type": "CUSTOM", "properties": { "layout": { "top": 320, "left": 200, "width": 640, "height": 360 }, "strokes": [ { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 204, "green": 204, "blue": 204 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 245, "green": 245, "blue": 250 } } } } ] } }, { "meta": { "name": "Child Slide Landscape", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8" }, "type": "CUSTOM", "properties": { "layout": { "top": 2160, "left": 3010, "width": 1920, "height": 1080 }, "strokes": [ { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 17, "green": 24, "blue": 39 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } } } ] } }, { "meta": { "name": "Child Slide Portrait", "id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e" }, "type": "CUSTOM", "properties": { "layout": { "left": 2000, "width": 1080, "height": 1920 }, "strokes": [ { "captype": "CAPROUND", "width": 1, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 29, "green": 78, "blue": 216 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 248, "blue": 225 } } }, { "color": { "rgb": { "red": 255, "green": 204, "blue": 128 } }, "position": 1 } ] } } ] } }, { "meta": { "name": "Child A4", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "width": 794, "height": 1123 }, "strokes": [ { "jointype": "MITER", "width": 1, "position": "INSIDE", "fill": { "solid": { "color": { "hsb": { "saturation": 0.85, "brightness": 0.25, "hue": 0.0016975309 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } }, { "color": { "rgb": { "red": 229, "green": 231, "blue": 235 } }, "position": 1 } ], "type": "RADIAL" } } ] } }, { "meta": { "name": "Child Phone", "id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "left": 900, "width": 375, "height": 812 }, "strokes": [ { "captype": "CAPROUND", "width": 2, "fill": { "solid": { "color": { "rgb": { "red": 245, "green": 158, "blue": 11 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 227, "green": 242, "blue": 253 } } }, { "color": { "rgb": { "red": 219, "green": 234, "blue": 254 } }, "position": 0.5 }, { "color": { "rgb": { "red": 147, "green": 197, "blue": 253 } }, "position": 1 } ], "type": "ANGULAR" } } ] } }, { "meta": { "name": "Child Custom", "id": "74b0dfa1-9186-5290-a16c-89b51db3bd31" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "left": 1400, "width": 600, "height": 800 }, "strokes": [ { "captype": "SQUARE", "width": 2, "position": "OUTSIDE", "type": "SQUARE_DOT", "fill": { "solid": { "color": { "hsb": { "saturation": 0.7, "brightness": 0.65, "hue": 0.0023148148 } } } } } ], "fills": [ { "no_fill": {} } ] } } ], "total_count": 6 }, "message": "Nested frames fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1002", "id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a02", "message": "Frame not found" }, { "error_code": "EL1002", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f29", "message": "Frame not found" }, { "error_code": "EL1002", "id": "74b0dfa1-9186-5290-a16c-89b51db3bd32", "message": "Frame not found" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx2" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames on Frame" ] }, "delete": { "summary": "Delete one or more child frames from a parent frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteFrameFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "results": [ { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "frame_id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0", "status": "success" }, { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567899", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" }, { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Multiple Frames": { "value": { "data": { "results": [ { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "frame_id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "status": "success" }, { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "frame_id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e", "status": "success" }, { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "frame_id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b", "status": "success" } ] }, "message": "Nested frames deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Single Frame": { "value": { "data": { "results": [ { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "frame_id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a03", "status": "success" } ] }, "message": "Nested frames deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "00000000-0000-0000-0000-000000000001", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" }, { "id": "00000000-0000-0000-0000-000000000002", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "5777000000915007" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/frames/00000000-0000-0000-0000-000000000000/frames", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx2" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames on Frame" ] }, "put": { "summary": "Update one or more child frames of a parent frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutFramesRequest" } } } }, "operationId": "updateFrameFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "results": [ { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0", "status": "success" }, { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e", "status": "success" }, { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" }, { "id": "ffffffff-ffff-ffff-ffff-ffffffffffff", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Multiple Frames": { "value": { "data": { "results": [ { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "status": "success" }, { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b", "status": "success" }, { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "id": "74b0dfa1-9186-5290-a16c-89b51db3bd31", "status": "success" } ] }, "message": "Nested frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Single Frame": { "value": { "data": { "results": [ { "parent_frame_id": "B25E9FE2-0605-4370-85E5-B142D133C3BC", "id": "b5fc46d8-ab45-5e51-bff3-5a59345b3a03", "status": "success" } ] }, "message": "Nested frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" }, { "id": "ffffffff-ffff-ffff-ffff-ffffffffffff", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Missing 'frames' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "frames", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "Frame Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } }, "No Facet": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "items[0].elements[0] must carry at least one of 'properties'", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/38CBB766-8052-48D2-9323-067C16BAAD90/frames/B25E9FE2-0605-4370-85E5-B142D133C3BC/frames", "status": "error" } }, "Empty 'frames' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "frames", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/frames", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken4" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx2" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames on Frame" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/text/{text_id}": { "get": { "summary": "Get text of a text-bearing object in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZoneText", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Default (fetch_type=text, all_text)": { "value": { "data": { "text": "Hello World\nSecond paragraph line" }, "message": "Text resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129", "status": "success" } }, "Range text_query": { "value": { "data": { "text": "Hello W" }, "message": "Text resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129", "status": "success" } }, "fetch_type=length": { "value": { "data": { "length": 33 }, "message": "Text length resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129", "status": "success" } }, "fetch_type=paragraph_text With text_query": { "value": { "data": { "paragraphs": [ { "paragraph_index": 0, "text": "Hello World" }, { "paragraph_index": 1, "text": "Second paragraph line" }, { "paragraph_index": 2, "text": "Para 1" }, { "paragraph_index": 3, "text": "Para 2" }, { "paragraph_index": 4, "text": "" } ] }, "message": "Paragraph text resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129", "status": "success" } }, "fetch_type=paragraph_count": { "value": { "data": { "paragraph_count": 2 }, "message": "Paragraph count resolved successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/text/18EC6574-83FD-4F7C-AD9E-F0022423F386", "status": "error" } }, "Invalid fetch_type": { "value": { "error": { "details": { "error_code": "IAM1036", "attribute": "fetch_type", "message": "The parameter value does not match the required pattern." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/a46f6013-6822-57cf-a71d-4dce016d3129", "status": "error" } }, "Malformed text_query JSON": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1004", "message": "Invalid field value", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/text/d4e5f6a7-b8c9-4d8e-bf12-4a5b6c7d8e9f", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/text/18EC6574-83FD-4F7C-AD9E-F0022423F386", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "5777000000915007" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/text/00000000-0000-0000-0000-000000000000", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/text/a46f6013-6822-57cf-a71d-4dce016d3123", "status": "error" } } } } } }, "404": { "description": "Not found - a resource named in the path does not exist, or is not visible to the caller", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Existent Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1008", "message": "Zone not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/5725A066-F499-439A-AABA-7461032413DE/text/18EC6574-83FD-4F7C-AD9E-F0022423F386", "status": "error" } }, "Non-Existent Element": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1001", "message": "Element not found", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/text/00000000-0000-0000-0000-000000000000", "status": "error" } }, "Non-Existent Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1009", "message": "Space not found", "space_id": "8000000000010" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/8000000000010/zones/1A0B4F55-BF08-4A1F-83B4-BCFC97EE3158/text/18EC6574-83FD-4F7C-AD9E-F0022423F386", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" }, "501": { "description": "Not implemented - this operation is not available for the requested resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Invalid": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1016", "message": "Not implemented for element type GROUPSHAPE", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/text/64B04181-0A88-4DB4-85E6-984B95A69B5F", "status": "error" } } } } } } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/TextId" }, { "$ref": "#/components/parameters/FetchType" }, { "$ref": "#/components/parameters/TextQuery" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Element Text" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/frames": { "post": { "summary": "Insert one or more zone-root frames into a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FrameInsertRequest" } } } }, "operationId": "createZoneFrame", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Frames": { "value": { "data": { "inserted_ids": [ "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "68747720-4a7f-5499-95b8-9ebf4b16fc7e", "6d198740-ac2c-5ac1-b7ab-90471f922f2b", "d2e81218-0c52-5fca-8e9b-bf68bccf38f0", "74b0dfa1-9186-5290-a16c-89b51db3bd31" ] }, "message": "Frames inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "success" } }, "Single Frame": { "value": { "data": { "inserted_ids": [ "a409ffba-f601-54f2-a2b6-57046407aacd" ] }, "message": "Frames inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames", "status": "error" } }, "Missing 'frames' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "frames", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "5777000000912012" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000912012/zones/edc821da-d3d9-4cd0-b075-fe25698ff98a/frames", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "error" } }, "Frames Without Meta": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "meta", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "error" } }, "Empty 'frames' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "frames", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "No EDIT Permission": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "5777000000915007" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000915007/zones/492724BD-4FD7-4851-ACF9-50EB08B730D7/frames", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx9" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames" ] }, "get": { "summary": "Get the zone-root frames in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZoneFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "frames": [ { "meta": { "name": "Slide Landscape", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8" }, "graphic_objects": [ { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "D767F5FA-82BF-4694-8690-220CBDC46E46", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 558.59375, "left": 1124.7266, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "11209A82-3D89-4384-AD8F-CDCF1B93C67C" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "FD77B19F-41DE-433B-A652-FF90D4306E56", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 159.45312, "left": 1533.0078, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "EF25C6E5-BDBE-423B-8244-818DB95FD79A" } ], "type": "CUSTOM", "properties": { "layout": { "width": 1920, "height": 1080 }, "strokes": [ { "width": 5, "fill": { "solid": { "color": { "rgb": { "red": 17, "green": 24, "blue": 39 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } } } ] } }, { "meta": { "name": "Slide Portrait", "id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e" }, "type": "CUSTOM", "properties": { "layout": { "left": 2000, "width": 1080, "height": 1920 }, "strokes": [ { "captype": "CAPROUND", "width": 5, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 29, "green": 78, "blue": 216 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 248, "blue": 225 } } }, { "color": { "rgb": { "red": 255, "green": 204, "blue": 128 } }, "position": 1 } ] } } ] } }, { "meta": { "name": "A4", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "width": 794, "height": 1123 }, "strokes": [ { "jointype": "MITER", "width": 4.5, "position": "INSIDE", "fill": { "solid": { "color": { "hsb": { "saturation": 0.85, "brightness": 0.25, "hue": 0.0016975309 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } }, { "color": { "rgb": { "red": 229, "green": 231, "blue": 235 } }, "position": 1 } ], "type": "RADIAL" } } ] } } ], "total_count": 3 }, "message": "Frames fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 2, "elements": [ { "meta": { "name": "Slide Landscape", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8" }, "type": "CUSTOM", "properties": { "layout": { "width": 1920, "height": 1080 }, "strokes": [ { "width": 1, "fill": { "solid": { "color": { "rgb": { "red": 17, "green": 24, "blue": 39 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } } } ] } }, { "meta": { "name": "Slide Portrait", "id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e" }, "type": "CUSTOM", "properties": { "layout": { "left": 2000, "width": 1080, "height": 1920 }, "strokes": [ { "captype": "CAPROUND", "width": 1, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 29, "green": 78, "blue": 216 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 248, "blue": 225 } } }, { "color": { "rgb": { "red": 255, "green": 204, "blue": 128 } }, "position": 1 } ] } } ] } } ], "errors": [ { "error_code": "EL1002", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f29", "message": "Frame not found" }, { "error_code": "EL1002", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b5", "message": "Frame not found" }, { "error_code": "EL1002", "id": "EF338BA3-8E7B-478A-9054-D9D2789A2E7E", "message": "Frame not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Default": { "value": { "data": { "frames": [ { "meta": { "name": "Slide Landscape", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8" }, "type": "CUSTOM", "properties": { "layout": { "width": 1920, "height": 1080 }, "strokes": [ { "width": 5, "fill": { "solid": { "color": { "rgb": { "red": 17, "green": 24, "blue": 39 } } } } } ], "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } } } ] } }, { "meta": { "name": "Slide Portrait", "id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e" }, "type": "CUSTOM", "properties": { "layout": { "left": 2000, "width": 1080, "height": 1920 }, "strokes": [ { "captype": "CAPROUND", "width": 5, "type": "DASH", "fill": { "solid": { "color": { "rgb": { "red": 29, "green": 78, "blue": 216 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 248, "blue": 225 } } }, { "color": { "rgb": { "red": 255, "green": 204, "blue": 128 } }, "position": 1 } ] } } ] } }, { "meta": { "name": "A4", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "width": 794, "height": 1123 }, "strokes": [ { "jointype": "MITER", "width": 4.5, "position": "INSIDE", "fill": { "solid": { "color": { "hsb": { "saturation": 0.85, "brightness": 0.25, "hue": 0.0016975309 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } } }, { "color": { "rgb": { "red": 229, "green": 231, "blue": 235 } }, "position": 1 } ], "type": "RADIAL" } } ] } }, { "meta": { "name": "Phone", "id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "left": 900, "width": 375, "height": 812 }, "strokes": [ { "captype": "CAPROUND", "width": 7, "fill": { "solid": { "color": { "rgb": { "red": 245, "green": 158, "blue": 11 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 227, "green": 242, "blue": 253 } } }, { "color": { "rgb": { "red": 219, "green": 234, "blue": 254 } }, "position": 0.5 }, { "color": { "rgb": { "red": 147, "green": 197, "blue": 253 } }, "position": 1 } ], "type": "ANGULAR" } } ] } }, { "meta": { "name": "Custom", "id": "74b0dfa1-9186-5290-a16c-89b51db3bd31" }, "type": "CUSTOM", "properties": { "layout": { "top": 2000, "left": 1400, "width": 600, "height": 800 }, "strokes": [ { "captype": "SQUARE", "width": 6, "position": "OUTSIDE", "type": "SQUARE_DOT", "fill": { "solid": { "color": { "hsb": { "saturation": 0.7, "brightness": 0.65, "hue": 0.0023148148 } } } } } ], "fills": [ { "noFill": {} } ] } } ], "total_count": 5 }, "message": "Frames fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/DEDA88D7-7A93-4D83-B69A-F5218927091C/frames", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1002", "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b5", "message": "Frame not found" }, { "error_code": "EL1002", "id": "68747720-4a7f-5499-95b8-9ebf4b16fc72", "message": "Frame not found" }, { "error_code": "EL1002", "id": "6d198740-ac2c-5ac1-b7ab-90471f922f21", "message": "Frame not found" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx9" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames" ] }, "delete": { "summary": "Delete one or more zone-root frames from a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteZoneFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "results": [ { "frame_id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "status": "success" }, { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Multiple Frames": { "value": { "data": { "results": [ { "frame_id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b", "status": "success" }, { "frame_id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0", "status": "success" }, { "frame_id": "74b0dfa1-9186-5290-a16c-89b51db3bd31", "status": "success" } ] }, "message": "Frames deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Single Frame": { "value": { "data": { "results": [ { "frame_id": "a409ffba-f601-54f2-a2b6-57046407aacd", "status": "success" } ] }, "message": "Frames deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "00000000-0000-0000-0000-000000000001", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" }, { "id": "00000000-0000-0000-0000-000000000002", "errors": [ { "error_code": "EL1002", "message": "Frame not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken2" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx5" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames" ] }, "put": { "summary": "Update one or more zone-root frames in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutFramesRequest" } } } }, "operationId": "updateZoneFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "results": [ { "id": "6d198740-ac2c-5ac1-b7ab-90471f922f2b", "status": "success" }, { "id": "d2e81218-0c52-5fca-8e9b-bf68bccf38f0", "status": "success" }, { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" }, { "id": "ffffffff-ffff-ffff-ffff-ffffffffffff", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Multiple Frames": { "value": { "data": { "results": [ { "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "status": "success" }, { "id": "74b0dfa1-9186-5290-a16c-89b51db3bd31", "status": "success" }, { "id": "68747720-4a7f-5499-95b8-9ebf4b16fc7e", "status": "success" } ] }, "message": "Frames updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Single Frame": { "value": { "data": { "results": [ { "id": "f1f362c6-9a9f-58e5-8f47-149f741c91b8", "status": "success" } ] }, "message": "Frames updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" }, { "id": "ffffffff-ffff-ffff-ffff-ffffffffffff", "errors": [ { "error_code": "EL1002", "message": "Frame not found", "facet": "frame" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames", "status": "error" } }, "Missing 'frames' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "frames", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "No Facet": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "frames[0] must carry at least one of 'properties'", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Frames Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } }, "Empty 'frames' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "frames", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken2" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx5" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Frames" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/frames/{frame_id}/groupshapes": { "post": { "summary": "Group or ungroup shapes in a frame (op-aware)", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupOpRequest" } } } }, "operationId": "createFrameGroupshape", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Ungrouping 2": { "value": { "data": { "ungrouped_shape_ids": [ "a4f1c2d8-3b6e-3f02-9c1b-7d2a5e89f019", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f014", "bf55c824-2496-4268-abaf-3ba054bd19ba", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f019", "B37069B4-6676-4B1D-9DE8-13BF28854044", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f018", "f9dfbc1f-edae-40fb-b96b-9c6352571a30", "590A322C-1E47-425D-97C2-4DE977E3AE90" ], "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "21e04378-de72-4a85-8469-30de3ad8538b", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "b6f88c46-52c4-4a89-8c48-694457681236", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "6c44ecf4-6b5b-4361-b0c7-ebeb03a7b04b", "status": "success" } ] }, "message": "Shapes ungrouped in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Single Ungrouping": { "value": { "data": { "ungrouped_shape_ids": [ "b6f88c46-52c4-4a89-8c48-694457681236", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f013" ], "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "35682aa9-d20d-49ae-bb74-035b6814b66c", "status": "success" } ] }, "message": "Shapes ungrouped in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Failure - Grouping": { "value": { "data": { "errors": [ { "requested_ids": [ "483122b7-86d4-411a-b7a7-112c54d2d8a8", "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc" ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "ineligible_reasons": [ { "reason": "inside group; not groupable", "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 0, "eligible_ids": [ "483122b7-86d4-411a-b7a7-112c54d2d8a8" ] }, { "requested_ids": [ "2E4AF1EF-954F-4248-AC42-21708588020F", "18AF2C18-B680-469A-8B64-40FCFE7363F6" ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "ineligible_reasons": [ { "reason": "sticky note; not groupable", "id": "2E4AF1EF-954F-4248-AC42-21708588020F" }, { "reason": "inside structure; not groupable", "id": "18AF2C18-B680-469A-8B64-40FCFE7363F6" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 1, "eligible_ids": [] }, { "requested_ids": [ "347DE061-9E36-437B-BB6D-DBD363ECD2C3", "9F831DBA-3F4E-4339-9276-5331DDC93CF9" ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "ineligible_reasons": [ { "reason": "table placeholder; not groupable", "id": "347DE061-9E36-437B-BB6D-DBD363ECD2C3" }, { "reason": "table; not groupable", "id": "9F831DBA-3F4E-4339-9276-5331DDC93CF9" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 2, "eligible_ids": [] }, { "requested_ids": [ "9F831DBA-3F4E-4339-9276-5331DDC93CF8", "465F648E-186D-4739-883B-F00F68627938" ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "ineligible_reasons": [ { "reason": "element not found", "id": "9F831DBA-3F4E-4339-9276-5331DDC93CF8" }, { "reason": "video placeholder; not groupable", "id": "465F648E-186D-4739-883B-F00F68627938" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 3, "eligible_ids": [] }, { "requested_ids": [ "816df1e3-f3d7-4682-b3ef-45f0dddb392a" ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "message": "At least 2 eligible ids are required for grouping", "group_index": 4, "eligible_ids": [ "816df1e3-f3d7-4682-b3ef-45f0dddb392a" ] } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Single Grouping": { "value": { "data": { "results": [ { "group_id": "b6f88c46-52c4-4a89-8c48-694457681236", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "group_index": 0, "status": "success" } ] }, "message": "Shapes grouped in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Partial Success - Grouping": { "value": { "data": { "results": [ { "groups": [ { "group_id": "483122b7-86d4-411a-b7a7-112c54d2d8a8", "group_index": 0, "status": "success" }, { "group_id": "816df1e3-f3d7-4682-b3ef-45f0dddb392a", "group_index": 1, "errors": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "id": "9F02A23F-2616-4865-8939-1424C969B59A", "message": "Id already used in another group", "group_index": 1 } ], "status": "partial" } ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ], "errors": [ { "requested_ids": [ "2C60126E-E060-469B-9D92-B3B17989A9FF", "BB215227-9219-4512-9E81-BEF0D7B3FC71" ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "ineligible_reasons": [ { "reason": "structure; not groupable", "id": "2C60126E-E060-469B-9D92-B3B17989A9FF" }, { "reason": "locked; not groupable", "id": "BB215227-9219-4512-9E81-BEF0D7B3FC71" } ], "message": "At least 2 eligible ids are required for grouping", "group_index": 2, "eligible_ids": [] } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Multiple Grouping": { "value": { "data": { "results": [ { "groups": [ { "group_id": "21e04378-de72-4a85-8469-30de3ad8538b", "group_index": 0, "status": "success" }, { "group_id": "35682aa9-d20d-49ae-bb74-035b6814b66c", "group_index": 1, "status": "success" }, { "group_id": "f9dfbc1f-edae-40fb-b96b-9c6352571a30", "group_index": 2, "status": "success" } ], "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "Shapes grouped in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Multiple Ungrouping": { "value": { "data": { "ungrouped_shape_ids": [ "a4f1c2d8-3b6e-3f02-9c1b-7d2a5e89f019", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f014", "bf55c824-2496-4268-abaf-3ba054bd19ba", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f019", "B37069B4-6676-4B1D-9DE8-13BF28854044", "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f018", "f9dfbc1f-edae-40fb-b96b-9c6352571a30", "590A322C-1E47-425D-97C2-4DE977E3AE90" ], "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "21e04378-de72-4a85-8469-30de3ad8538b", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "b6f88c46-52c4-4a89-8c48-694457681236", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "6c44ecf4-6b5b-4361-b0c7-ebeb03a7b04b", "status": "success" } ] }, "message": "Shapes ungrouped in frame successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Partial Success - Ungrouping": { "value": { "data": { "ungrouped_shape_ids": [ "590A322C-1E47-425D-97C2-4DE977E3AE90", "757F7D65-EDBB-4447-B743-5520B1BA3667", "C4A58170-EB6A-4C1F-8705-9DD091E900D4", "FB88F7D0-07E5-4CE9-9FE8-5B24D24A1F54" ], "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "CCCD11DE-CDBE-4162-97BC-CFC949868293", "status": "success" } ], "errors": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1001", "id": "b6f88c46-52c4-4a89-8c48-694457681232", "message": "Element not found" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1018", "id": "CCCD11DE-CDBE-4162-97BC-CFC949868293", "message": "Id appears more than once" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Failure - Ungrouping": { "value": { "data": { "errors": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1006", "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc", "message": "Inside GROUPSHAPE container cannot be ungrouped" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1006", "id": "2E4AF1EF-954F-4248-AC42-21708588020F", "message": "Specialised STICKYNOTE container cannot be ungrouped" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1006", "id": "2C60126E-E060-469B-9D92-B3B17989A9FF", "message": "Specialised STRUCTURE container cannot be ungrouped" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "error_code": "EL1006", "id": "EF4BD861-2CCD-47EE-A7D8-937A457B8394", "message": "Inside STRUCTURE container cannot be ungrouped" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Missing 'op' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "op", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Empty 'groups' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "groups", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Invalid Request": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "Provide exactly one of 'groups' or 'nested_groups', not both", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Missing 'groups' Field": { "value": { "error": { "details": { "error_code": "EL1018", "message": "Provide 'nested_groups' for op=group or 'groups' for op=ungroup" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Invalid 'op' Value": { "value": { "error": { "details": { "error_code": "IAM1036", "attribute": "op", "message": "The parameter value does not match the required pattern." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken5" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx3" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes on Frame" ] }, "get": { "summary": "Get the group shapes in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getFrameGroupshapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "total_count": 3, "elements": [ { "group_shape": { "layout": { "top": 80, "left": 80, "width": 480, "height": 320 }, "objects": [ { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, "second": { "side": "WEST", "marker": "OPEN", "shape_id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "bbbbbbbb-2222-4222-8222-bbbbbbbbbbbb", "portions": [ { "style": { "fontweight": "NORMAL", "size": 12, "color": { "rgb": { "red": 30, "green": 30, "blue": 30 } } }, "text": "Line A→C" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "stroke": { "jointype": "MITER", "width": 3, "type": "DASH", "fill": { "solid": { "color": { "rgb": {} } } } } }, "id": "22222222-1111-4111-8111-aaaaaaaaaaaa" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "d8e9f0a1-b2c3-4d45-9e67-12345678abcd", "portions": [ { "style": { "fontweight": "BOLD", "size": 36, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Inter" } }, "text": "Single element" } ] } ], "properties": { "inset": { "top": 12, "left": 16, "bottom": 12, "right": 16 }, "auto_fit": "TEXT" } }, "basic": { "rounded_rectangle": {}, "type": "ROUNDED_RECTANGLE" }, "properties": { "layout": { "top": 2588.8672, "left": 1478.9033, "width": 1000.001, "height": 500 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "fill": { "solid": { "color": { "rgb": { "red": 6, "green": 182, "blue": 212 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 15, "green": 23, "blue": 42 } } }, { "color": { "rgb": { "red": 30, "green": 41, "blue": 59 } }, "position": 1 } ] }, "alpha": 0.2 } ] } } }, "id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f013" }, { "group_shape": { "layout": { "top": 3453.8926, "left": 1292.2783, "width": 742.147, "height": 1625.703 }, "objects": [ { "group_shape": { "layout": { "top": -2749.4653, "left": 3687.6516, "width": 559.37476, "height": 151.99219 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "7F5AF8E4-7B4E-447C-BB93-843977B33C99", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -2722.4731, "left": 4122.0264, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "70D504DE-58DE-4422-89CE-744F3AFDF1D0", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": -2749.4653, "left": 3687.6516, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "EFC7A9A1-4294-4560-BD83-C9A8F0EFD3F3" } ] }, "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "8253817E-D4BE-434D-BBB0-28A33D35FC12", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "TRIANGLE", "triangle": {} }, "properties": { "layout": { "top": -1248.7622, "left": 4304.8, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5" } ] }, "id": "bf55c824-2496-4268-abaf-3ba054bd19ba" } ] }, "id": "151E7B25-6454-426A-9B3E-2DF8266EA459" }, { "group_shape": { "layout": { "rotate": 12, "top": 337.53296, "left": 1236.9053, "width": 360, "fliph": true, "height": 260 }, "objects": [ { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "BF40EAE8-36EC-4940-9215-0DBDC1F136DC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 4062.5254, "left": 4109.9414, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9F02A23F-2616-4865-8939-1424C969B59A" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "89EC4CF3-461C-4C67-B041-A6F8B6D89B39", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 4345.963, "left": 4590.6836, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "B3FB1A32-09EC-4CDF-8BB4-215E1B8E77CC" } ] }, "id": "483122b7-86d4-411a-b7a7-112c54d2d8a8" }, { "group_shape": { "layout": { "rotate": 352, "top": 1010, "left": 580.38965, "width": 420, "flipv": true, "height": 220 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "6E0315B8-AB67-4037-8197-169181A92CEB", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "DIAMOND" }, "properties": { "layout": { "top": 3792.4863, "left": 4734.8237, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "B364B947-10F0-42EE-9095-8918EE264986" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "ECA2FD88-8EDE-43CA-AF25-1AB79B30322D", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "block_arrow": { "single_arrow": {} }, "properties": { "layout": { "top": 3855.1426, "left": 5130.722, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "D72350DD-CBD3-4164-AC99-08437A3D9679" } ] }, "id": "816df1e3-f3d7-4682-b3ef-45f0dddb392a" } ] }, "message": "GroupShapes in frame fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 2, "elements": [ { "group_shape": { "layout": { "rotate": 12, "top": 337.53296, "left": 1236.9053, "width": 360, "fliph": true, "height": 260 }, "objects": [ { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "BF40EAE8-36EC-4940-9215-0DBDC1F136DC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 4062.5254, "left": 4109.9414, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9F02A23F-2616-4865-8939-1424C969B59A" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "89EC4CF3-461C-4C67-B041-A6F8B6D89B39", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 4345.963, "left": 4590.6836, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "B3FB1A32-09EC-4CDF-8BB4-215E1B8E77CC" } ] }, "id": "483122b7-86d4-411a-b7a7-112c54d2d8a8" }, { "group_shape": { "layout": { "rotate": 352, "top": 1010, "left": 580.38965, "width": 420, "flipv": true, "height": 220 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "6E0315B8-AB67-4037-8197-169181A92CEB", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "DIAMOND" }, "properties": { "layout": { "top": 3792.4863, "left": 4734.8237, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "B364B947-10F0-42EE-9095-8918EE264986" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "ECA2FD88-8EDE-43CA-AF25-1AB79B30322D", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "block_arrow": { "single_arrow": {} }, "properties": { "layout": { "top": 3855.1426, "left": 5130.722, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "D72350DD-CBD3-4164-AC99-08437A3D9679" } ] }, "id": "816df1e3-f3d7-4682-b3ef-45f0dddb392a" } ], "errors": [ { "error_code": "EL1006", "id": "a4f1c2d8-3b6e-3f02-9c1b-7d2a5e89f019", "message": "Not a groupshape" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Default": { "value": { "data": { "total_count": 3, "elements": [ { "group_shape": { "layout": { "top": 80, "left": 80, "width": 480, "height": 320 }, "objects": [ { "connector": { "connected": { "first": { "side": "EAST", "marker": "NONE", "shape_id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, "second": { "side": "WEST", "marker": "OPEN", "shape_id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5" } }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "bbbbbbbb-2222-4222-8222-bbbbbbbbbbbb", "portions": [ { "style": { "fontweight": "NORMAL", "size": 12, "color": { "rgb": { "red": 30, "green": 30, "blue": 30 } } }, "text": "Line A→C" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 } } }, "stroke": { "jointype": "MITER", "width": 3, "type": "DASH", "fill": { "solid": { "color": { "rgb": {} } } } } }, "id": "22222222-1111-4111-8111-aaaaaaaaaaaa" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "d8e9f0a1-b2c3-4d45-9e67-12345678abcd", "portions": [ { "style": { "fontweight": "BOLD", "size": 36, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Inter" } }, "text": "Single element" } ] } ], "properties": { "inset": { "top": 12, "left": 16, "bottom": 12, "right": 16 }, "auto_fit": "TEXT" } }, "basic": { "rounded_rectangle": {}, "type": "ROUNDED_RECTANGLE" }, "properties": { "layout": { "top": 2588.8672, "left": 1478.9033, "width": 1000.001, "height": 500 }, "strokes": [ { "captype": "CAPROUND", "width": 4, "fill": { "solid": { "color": { "rgb": { "red": 6, "green": 182, "blue": 212 } } } } } ], "fills": [ { "gradient": { "stops": [ { "color": { "rgb": { "red": 15, "green": 23, "blue": 42 } } }, { "color": { "rgb": { "red": 30, "green": 41, "blue": 59 } }, "position": 1 } ] }, "alpha": 0.2 } ] } } }, "id": "a4f1c2d8-3b6e-4f02-9c1b-7d2a5e89f013" }, { "group_shape": { "layout": { "top": 3453.8926, "left": 1292.2783, "width": 742.147, "height": 1625.703 }, "objects": [ { "group_shape": { "layout": { "top": -2749.4653, "left": 3687.6516, "width": 559.37476, "height": 151.99219 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "7F5AF8E4-7B4E-447C-BB93-843977B33C99", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": -2722.4731, "left": 4122.0264, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "BAD2B78A-C17A-4A75-BFD7-89CD2ABDF7E8" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "70D504DE-58DE-4422-89CE-744F3AFDF1D0", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": -2749.4653, "left": 3687.6516, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "EFC7A9A1-4294-4560-BD83-C9A8F0EFD3F3" } ] }, "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "8253817E-D4BE-434D-BBB0-28A33D35FC12", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "TRIANGLE", "triangle": {} }, "properties": { "layout": { "top": -1248.7622, "left": 4304.8, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D5" } ] }, "id": "bf55c824-2496-4268-abaf-3ba054bd19ba" } ] }, "id": "151E7B25-6454-426A-9B3E-2DF8266EA459" }, { "group_shape": { "layout": { "rotate": 12, "top": 337.53296, "left": 1236.9053, "width": 360, "fliph": true, "height": 260 }, "objects": [ { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "BF40EAE8-36EC-4940-9215-0DBDC1F136DC", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 4062.5254, "left": 4109.9414, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "9F02A23F-2616-4865-8939-1424C969B59A" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "89EC4CF3-461C-4C67-B041-A6F8B6D89B39", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "OVAL" }, "properties": { "layout": { "top": 4345.963, "left": 4590.6836, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "B3FB1A32-09EC-4CDF-8BB4-215E1B8E77CC" } ] }, "id": "483122b7-86d4-411a-b7a7-112c54d2d8a8" }, { "group_shape": { "layout": { "rotate": 352, "top": 1010, "left": 580.38965, "width": 420, "flipv": true, "height": 220 }, "objects": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "6E0315B8-AB67-4037-8197-169181A92CEB", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "basic": { "type": "DIAMOND" }, "properties": { "layout": { "top": 3792.4863, "left": 4734.8237, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "B364B947-10F0-42EE-9095-8918EE264986" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "ECA2FD88-8EDE-43CA-AF25-1AB79B30322D", "portions": [ { "style": { "size": 18, "color": { "hsb": {} }, "font_name": { "name": "Open Sans" } } } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "block_arrow": { "single_arrow": {} }, "properties": { "layout": { "top": 3855.1426, "left": 5130.722, "width": 125, "height": 125 }, "strokes": [ { "jointype": "MITER", "width": 1.5, "fill": { "solid": { "color": { "hsb": { "saturation": 0.3, "brightness": 0.286, "hue": 0.764 } } } } } ], "fills": [ { "solid": { "color": { "hsb": { "brightness": 1 } } } } ] } } }, "id": "D72350DD-CBD3-4164-AC99-08437A3D9679" } ] }, "id": "816df1e3-f3d7-4682-b3ef-45f0dddb392a" } ] }, "message": "GroupShapes in frame fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1001", "id": "816df1e3-f3d7-4682-b3ef-45f0dddb3921", "message": "Element not found" }, { "error_code": "EL1006", "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc", "message": "Inside GROUPSHAPE container is not a groupshape" }, { "error_code": "EL1006", "id": "a4f1c2d8-3b6e-3f02-9c1b-7d2a5e89f019", "message": "Not a groupshape" }, { "error_code": "EL1006", "id": "2E4AF1EF-954F-4248-AC42-21708588020F", "message": "Specialised STICKYNOTE container is not a groupshape" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx3" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes on Frame" ] }, "delete": { "summary": "Delete one or more group shapes from a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteFrameGroupshapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "groupshape_id": "151E7B25-6454-426A-9B3E-2DF8266EA459", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "groupshape_id": "483122b7-86d4-411a-b7a7-112c54d2d8a8", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "GroupShapes in frame deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "groupshape_id": "510FE33B-B304-4010-A0D5-DE63902356AD", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "2C60126E-E060-469B-9D92-B3B17989A9FF", "errors": [ { "error_code": "EL1006", "message": "Specialised STRUCTURE container is not a groupshape" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "C5AFC202-A351-4DD1-A9D8-F0D1A1BDFDD3", "errors": [ { "error_code": "EL1006", "message": "Not a groupshape" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "00000000-0000-0000-0000-000000000001", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "848D9B76-A1D7-4A7A-B5CD-CEB4FF6452D55", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "groupshape_id": "816df1e3-f3d7-4682-b3ef-45f0dddb392a", "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "status": "success" } ] }, "message": "GroupShapes in frame deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken5" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx3" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes on Frame" ] }, "put": { "summary": "Update one or more group shapes in a frame", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutGroupShapesRequest" } } } }, "operationId": "updateFrameGroupshapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "151E7B25-6454-426A-9B3E-2DF8266EA459", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "483122b7-86d4-411a-b7a7-112c54d2d8a8", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "816df1e3-f3d7-4682-b3ef-45f0dddb392a", "status": "success" } ] }, "message": "GroupShape in frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "2E4AF1EF-954F-4248-AC42-21708588020F", "errors": [ { "error_code": "EL1006", "message": "Specialised STICKYNOTE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "151E7B25-6454-426A-9B3E-2DF8266EA459", "status": "success" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "483122b7-86d4-411a-b7a7-112c54d2d8a9", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "c1944aee-6bc4-4514-b7ce-cdfa8a1cacbc", "errors": [ { "error_code": "EL1006", "message": "Inside GROUPSHAPE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "2E4AF1EF-954F-4248-AC42-21708588020F", "errors": [ { "error_code": "EL1006", "message": "Specialised STICKYNOTE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "2C60126E-E060-469B-9D92-B3B17989A9FF", "errors": [ { "error_code": "EL1006", "message": "Specialised STRUCTURE container is not a groupshape", "facet": "element" } ], "status": "failed" }, { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "EF4BD861-2CCD-47EE-A7D8-937A457B8394", "errors": [ { "error_code": "EL1006", "message": "Inside STRUCTURE container is not a groupshape", "facet": "element" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "parent_frame_id": "0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061", "id": "151E7B25-6454-426A-9B3E-2DF8266EA459", "status": "success" } ] }, "message": "GroupShape in frame updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1066", "message": "Request body is missing or not valid." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } }, "No Facet": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "items[0].elements[0] must carry 'properties.layout' for group shape update", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/frames/0e7c1ab2-9d34-4f51-b6a0-1c2d3e4f5061/groupshapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken5" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx3" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/FrameId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Group Shapes on Frame" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/shapes": { "post": { "summary": "Insert one or more shapes into a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShapeInsertRequest" } } } }, "operationId": "createZoneShape", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements - I": { "value": { "data": { "inserted_ids": [ "e4163cc2-1d24-546b-a8a5-6b0817da7887", "d406b989-45f5-5018-a6b9-4f6671e32527", "0c568942-223e-5fec-9a5c-1989fe8c5f49", "5eeac863-9d71-5c23-8b30-6a0bc390b87f", "facef9f3-94dd-5fb6-bee7-c58cbd9f28b8" ] }, "message": "Shapes inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "success" } }, "Multiple Elements - II": { "value": { "data": { "inserted_ids": [ "8740168d-dea1-58bc-b551-ed8847fa9ef2", "d2f8315c-1743-5320-9287-b4574fdd8b8d", "0536f22c-96ed-5179-a7a0-ec3182b2532e", "a5f9c869-99ba-51db-8a3b-d981d6dded00", "3eb0c7a4-6b10-5585-a844-e893f8111d29", "ccf5b84e-2a13-50ba-81b1-402730293a44" ] }, "message": "Shapes inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "success" } }, "Single Element": { "value": { "data": { "inserted_ids": [ "a46f6013-6822-57cf-a71d-4dce016d3123" ] }, "message": "Shapes inserted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/shapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes", "status": "error" } }, "Element - Invalid ID": { "value": { "error": { "details": { "error_code": "IAM1036", "attribute": "id", "message": "The parameter value does not match the required pattern." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken8" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx6" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes" ] }, "get": { "summary": "Get the shapes in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZoneShapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "With ids filter": { "value": { "data": { "total_count": 3, "elements": [ { "shape": { "shape": { "flowchart": { "type": "PROCESS" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "a2893ee3-3085-5215-9254-e610c8589892", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Process" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 440, "left": 40, "width": 200, "height": 120 }, "fills": [ { "solid": { "color": { "rgb": { "red": 76, "green": 175, "blue": 80 } } } } ] } } }, "id": "8740168d-dea1-58bc-b551-ed8847fa9ef2" }, { "shape": { "shape": { "block_arrow": { "single_arrow": {} }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "64f7c556-37f0-5f0a-9881-8a582d18949e", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Next" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 440, "left": 280, "width": 200, "height": 120 }, "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 87, "blue": 34 } } } } ] } } }, "id": "d2f8315c-1743-5320-9287-b4574fdd8b8d" }, { "shape": { "shape": { "flowchart": { "type": "DECISION" }, "text": { "paragraphs": [ { "id": "2f2eeccd-410c-419c-acd6-09d74343fa6e", "portions": [ { "style": { "fontweight": "NORMAL" } } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 } } }, "properties": { "layout": { "top": 40, "left": 520, "width": 200, "height": 120 } } } }, "id": "44444444-4444-5444-9444-444444444444" } ] }, "message": "Shapes fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "success" } }, "Partial Success": { "value": { "data": { "total_count": 2, "elements": [ { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "11111111-aaaa-4111-8aaa-111111111aaa", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "hsb": { "saturation": 0.7979798, "brightness": 0.7764706 } }, "underline": true, "italic": true, "font_name": { "name": "Open Sans" } }, "text": "HELLO" }, { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": " hello again" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 668, "left": -181, "width": 240, "height": 80 }, "fills": [ { "solid": { "color": { "rgb": { "red": 25, "green": 118, "blue": 210 } } }, "alpha": 1 } ] } } }, "id": "11111111-1111-4111-8111-111111111111" }, { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "before": 6, "line": 1.5 }, "halign": "CENTER" }, "id": "5076D670-1DFA-40D7-B984-437FBCED393C", "portions": [ { "style": { "fontweight": "BOLD", "size": 16, "color": { "hsb": { "brightness": 1 } }, "font_name": { "name": "Open Sans" } }, "text": "Hello World" } ] } ], "properties": { "inset": { "top": 5, "left": 5, "bottom": 5, "right": 5 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 772, "left": 494.00003, "width": 240, "height": 120 }, "strokes": [ { "captype": "CAPROUND", "width": 1.5, "fill": { "solid": { "color": { "rgb": { "red": 183, "green": 28, "blue": 28 } } } } } ], "shadow": { "distance": 6, "color": { "rgb": {} }, "angle": 135, "blur": 12, "type": "OUTER" }, "reflection": { "alpha_start": 0.6, "distance": 4, "position_end": 1 }, "fills": [ { "solid": { "color": { "rgb": { "red": 25, "green": 118, "blue": 210 } } }, "alpha": 1 } ] } } }, "id": "FE0C9EDB-D1BA-446A-A402-5C4CB87F9458" } ], "errors": [ { "error_code": "EL1001", "id": "a2893ee3-3085-5215-9254-e610c8589892", "message": "Element not found" }, { "error_code": "EL1001", "id": "64f7c556-37f0-5f0a-9881-8a582d18949e", "message": "Element not found" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } }, "Default": { "value": { "data": { "total_count": 9, "elements": [ { "shape": { "shape": { "flowchart": { "type": "PROCESS" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "a2893ee3-3085-5215-9254-e610c8589892", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Process" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 440, "left": 40, "width": 200, "height": 120 }, "fills": [ { "solid": { "color": { "rgb": { "red": 76, "green": 175, "blue": 80 } } } } ] } } }, "id": "8740168d-dea1-58bc-b551-ed8847fa9ef2" }, { "shape": { "shape": { "block_arrow": { "single_arrow": {} }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "64f7c556-37f0-5f0a-9881-8a582d18949e", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Next" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 440, "left": 280, "width": 200, "height": 120 }, "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 87, "blue": 34 } } } } ] } } }, "id": "d2f8315c-1743-5320-9287-b4574fdd8b8d" }, { "shape": { "shape": { "mathematical_symbol": {}, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "500cbb87-8a52-54ca-bfad-657cd618fbf5", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "+" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 440, "left": 520, "width": 120, "height": 120 }, "fills": [ { "solid": { "color": { "rgb": { "red": 156, "green": 39, "blue": 176 } } } } ] } } }, "id": "0536f22c-96ed-5179-a7a0-ec3182b2532e" }, { "shape": { "shape": { "callout": { "type": "ROUNDED_RECTANGLE_CALLOUT" }, "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "29914624-b757-5e5d-8977-ca08f157169a", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": {} }, "font_name": { "name": "Open Sans" } }, "text": "Note" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "properties": { "layout": { "top": 440, "left": 680, "width": 220, "height": 140 }, "fills": [ { "solid": { "color": { "rgb": { "red": 255, "green": 235, "blue": 59 } } } } ] } } }, "id": "a5f9c869-99ba-51db-8a3b-d981d6dded00" }, { "shape": { "shape": { "text": { "paragraphs": [ { "style": { "spacing": { "line": 1.2 }, "level": 1, "halign": "CENTER" }, "id": "0e1ec429-9250-55fb-9e86-2083f25b3b21", "portions": [ { "style": { "fontweight": "NORMAL", "size": 18, "color": { "rgb": { "red": 255, "green": 255, "blue": 255 } }, "font_name": { "name": "Open Sans" } }, "text": "Custom" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 }, "auto_fit": "TEXT" } }, "basic": {}, "properties": { "layout": { "top": 620, "left": 40, "width": 200, "height": 200 }, "fills": [ { "solid": { "color": { "rgb": { "red": 96, "green": 125, "blue": 139 } } } } ] } } }, "id": "3eb0c7a4-6b10-5585-a844-e893f8111d29" }, { "shape": { "shape": { "text": { "paragraphs": [ { "id": "b41decf4-b50c-47be-95a0-04938fc5e533", "portions": [ { "style": { "fontweight": "NORMAL", "color": { "hsb": { "saturation": 0.7957, "brightness": 0.36471, "hue": 0.27478 } } }, "text": "nnsjnssjs" } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 } } }, "basic": {}, "properties": { "layout": { "top": 620, "left": 280, "width": 360, "height": 80 } } } }, "id": "ccf5b84e-2a13-50ba-81b1-402730293a44" }, { "shape": { "shape": { "flowchart": { "type": "PROCESS" }, "text": { "paragraphs": [ { "id": "83f1003c-b398-4907-95b6-586c31dfa170", "portions": [ { "style": { "fontweight": "NORMAL" } } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 } } }, "properties": { "layout": { "top": 40, "left": 40, "width": 200, "height": 120 } } } }, "id": "11111111-1111-5111-9111-111111111111" }, { "shape": { "shape": { "block_arrow": { "single_arrow": {} }, "text": { "paragraphs": [ { "id": "7032105a-4b28-4fe7-a3ac-84c0426b1539", "portions": [ { "style": { "fontweight": "NORMAL" } } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 } } }, "properties": { "layout": { "top": 40, "left": 280, "width": 200, "height": 120 } } } }, "id": "22222222-2222-5222-9222-222222222222" }, { "shape": { "shape": { "flowchart": { "type": "DECISION" }, "text": { "paragraphs": [ { "id": "2f2eeccd-410c-419c-acd6-09d74343fa6e", "portions": [ { "style": { "fontweight": "NORMAL" } } ] } ], "properties": { "inset": { "top": 5, "left": 10, "bottom": 5, "right": 10 } } }, "properties": { "layout": { "top": 40, "left": 520, "width": 200, "height": 120 } } } }, "id": "44444444-4444-5444-9444-444444444444" } ] }, "message": "Shapes fetched successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "success" } }, "Failure": { "value": { "data": { "errors": [ { "error_code": "EL1001", "id": "a2893ee3-3085-5215-9254-e610c8589892", "message": "Element not found" }, { "error_code": "EL1001", "id": "64f7c556-37f0-5f0a-9881-8a582d18949e", "message": "Element not found" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/shapes", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "No VIEW Permission": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "2830000002600178" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600178/zones/1d5151b3-a39d-4eda-954e-3da6a6329408/shapes", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx6" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" }, { "$ref": "#/components/parameters/Ids" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes" ] }, "delete": { "summary": "Delete one or more shapes from a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatDeleteIdsRequest" } } } }, "operationId": "deleteZoneShapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements": { "value": { "data": { "results": [ { "shape_id": "FE0C9EDB-D1BA-446A-A402-5C4CB87F9458", "status": "success" }, { "shape_id": "1F9A7500-7CF3-4E9A-A946-524CD817744B", "status": "success" }, { "shape_id": "937E51FD-6C25-4870-A936-D97522394925", "status": "success" } ] }, "message": "Shapes deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "shape_id": "46291D80-981E-4CA0-AE9B-BF5C913741D5", "status": "success" }, { "shape_id": "02439698-C156-411D-8A77-1987C9050664", "status": "success" }, { "id": "10000000-0000-1000-1000-100000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "00000000-0000-0000-0000-000000000000", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" }, { "id": "11111111-1111-1111-1111-111111111111", "errors": [ { "error_code": "EL1001", "message": "Element not found" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "shape_id": "44444444-4444-4444-8444-444444444444", "status": "success" } ] }, "message": "Shapes deleted successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Missing 'ids' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes", "status": "error" } }, "Empty 'groups' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/shapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Empty 'ids' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "ids", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/051E5823-1E79-4841-BB26-31329FB388CD/shapes", "status": "error" } }, "Missing 'groups' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "ids", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken8" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx6" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes" ] }, "put": { "summary": "Update one or more shapes in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlatPutShapesRequest" } } } }, "operationId": "updateZoneShapes", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Multiple Elements - III (Text Mutations and Styles)": { "value": { "data": { "results": [ { "id": "CF7D1480-628C-476D-9923-AEE7C5D3C742", "status": "success" }, { "id": "49BA9283-408C-47B4-828D-4E9880A9161F", "status": "success" }, { "id": "339D2634-16D3-4445-A675-4696B8FD4EBB", "status": "success" }, { "id": "269FAC98-B4F5-41D1-9643-6368706BF69E", "status": "success" }, { "id": "A16989F9-5C29-4141-A303-BA07C9A62AE9", "status": "success" }, { "id": "10C43DC2-F3BD-470C-8929-85B593CBE9B1", "status": "success" }, { "id": "04164FA1-35C8-4BE1-840C-78ACDA7CCCB6", "status": "success" }, { "id": "D33D70D0-AEE6-4A8F-B882-546E2E66A6E0", "status": "success" } ] }, "message": "Shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1A0B4F55-BF08-4A1F-83B4-BCFC97EE3158/shapes", "status": "success" } }, "Multiple Elements - II (Stroke and Layout)": { "value": { "data": { "results": [ { "id": "CF7D1480-628C-476D-9923-AEE7C5D3C742", "status": "success" }, { "id": "49BA9283-408C-47B4-828D-4E9880A9161F", "status": "success" }, { "id": "339D2634-16D3-4445-A675-4696B8FD4EBB", "status": "success" }, { "id": "269FAC98-B4F5-41D1-9643-6368706BF69E", "status": "success" }, { "id": "A16989F9-5C29-4141-A303-BA07C9A62AE9", "status": "success" }, { "id": "10C43DC2-F3BD-470C-8929-85B593CBE9B1", "status": "success" }, { "id": "04164FA1-35C8-4BE1-840C-78ACDA7CCCB6", "status": "success" }, { "id": "D33D70D0-AEE6-4A8F-B882-546E2E66A6E0", "status": "success" } ] }, "message": "Shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1A0B4F55-BF08-4A1F-83B4-BCFC97EE3158/shapes", "status": "success" } }, "Partial Success": { "value": { "data": { "results": [ { "id": "11111111-1111-4111-8111-111111111111", "status": "success" }, { "id": "22222222-2222-4222-8222-222222222222", "status": "success" }, { "id": "99999999-9999-4999-8999-999999999999", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "88888888-8888-4888-8888-888888888888", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "33333333-3333-4333-8333-333333333333", "errors": [ { "error_code": "EL1018", "message": "mutations[0]: Invalid text range [0, 99999). Text length: 70", "facet": "text_mutations" } ], "status": "failed" } ] }, "message": "Partial success: some operations failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } }, "Multiple Elements - I (Fills)": { "value": { "data": { "results": [ { "id": "CF7D1480-628C-476D-9923-AEE7C5D3C742", "status": "success" }, { "id": "49BA9283-408C-47B4-828D-4E9880A9161F", "status": "success" }, { "id": "339D2634-16D3-4445-A675-4696B8FD4EBB", "status": "success" }, { "id": "269FAC98-B4F5-41D1-9643-6368706BF69E", "status": "success" }, { "id": "A16989F9-5C29-4141-A303-BA07C9A62AE9", "status": "success" } ] }, "message": "Shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1A0B4F55-BF08-4A1F-83B4-BCFC97EE3158/shapes", "status": "success" } }, "Failure": { "value": { "data": { "results": [ { "id": "99999999-9999-4999-8999-999999999999", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "88888888-8888-4888-8888-888888888888", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "77777777-7777-4777-8777-777777777779", "errors": [ { "error_code": "EL1001", "message": "Element not found", "facet": "element" } ], "status": "failed" }, { "id": "33333333-3333-4333-8333-333333333333", "errors": [ { "error_code": "EL1018", "message": "mutations[0]: Invalid text range [0, 99999). Text length: 70", "facet": "text_mutations" } ], "status": "failed" } ] }, "message": "All operations in the batch failed", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } }, "Single Element": { "value": { "data": { "results": [ { "id": "11111111-1111-5111-9111-111111111111", "status": "success" } ] }, "message": "Shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "success" } }, "Single Element (Mixed - All the Above)": { "value": { "data": { "results": [ { "id": "FE0C9EDB-D1BA-446A-A402-5C4CB87F9458", "status": "success" } ] }, "message": "Shapes updated successfully", "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/1752719F-BBB3-412F-BE40-5334D5C2AAC5/shapes", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Malformed JSON": { "value": { "error": { "details": { "error_code": "IAM1050", "message": "The JSON content could not be parsed." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Empty 'elements' Array": { "value": { "error": { "details": { "error_code": "IAM1054", "attribute": "elements", "message": "The array size is out of the allowed range." } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Missing 'elements' Field": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Inactive Zone": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/85879463-3722-4956-A8B6-C744D4AB4108/shapes", "status": "error" } }, "Inactive Space": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "S1012", "message": "Space is not in an active state", "space_id": "2830000002600058" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600058/zones/076dc446-4442-422f-b70d-a45779228db8/shapes", "status": "error" } }, "Empty Body": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "elements", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "Element Without ID": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "id", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } }, "No Facet (Neither properties nor text)": { "value": { "error": { "details": { "edition_id": "88136506", "current_user_id": "85115776", "error_code": "EL1018", "message": "elements[0] must carry at least one of 'properties' or 'text'", "space_id": "2830000002600126" } }, "request_uri": "/vani/api/v1/editions/88136506/spaces/2830000002600126/zones/0FFDBC10-542D-4DB4-BA29-76A11200136E/shapes", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken8" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx6" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Shapes" ] } } }, "info": { "contact": { "name": "Vani API Support", "url": "https://www.vanihq.com/resources/api/doc/" }, "description": "Create, read, update, and delete the objects on a zone canvas: shapes, connectors, group shapes, frames, and their text.", "title": "Elements", "version": "1.0.0" }, "tags": [ { "name": "Shapes", "description": "Insert, list, update, and delete shapes directly on a zone." }, { "name": "Connectors", "description": "Insert, list, update, and delete connectors directly on a zone." }, { "name": "Group Shapes", "description": "Group and ungroup shapes directly on a zone." }, { "name": "Frames", "description": "Insert, list, update, and delete zone-root frames." }, { "name": "Shapes on Frame", "description": "Insert, list, update, and delete shapes inside a frame." }, { "name": "Connectors on Frame", "description": "Insert, list, update, and delete connectors inside a frame." }, { "name": "Group Shapes on Frame", "description": "Group and ungroup shapes inside a frame." }, { "name": "Frames on Frame", "description": "Insert, list, update, and delete child frames inside a parent frame." }, { "name": "Element Text", "description": "Read the text of a text-bearing object on a zone or frame." } ] }