{ "openapi": "3.1.0", "info": { "title": "Vani API", "version": "1.0.0", "description": "Edition-level resources: the edition itself, its subscription, join requests, and templates." }, "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}" } ], "tags": [ { "name": "Editions", "description": "Read and create editions, and check edition join-request status." }, { "name": "Subscription", "description": "Read the edition's subscription details." }, { "name": "Templates", "description": "List and read the templates available in an edition." }, { "name": "Teams", "description": "Read and update teams, and resolve a user's role within them." }, { "name": "Team Members", "description": "Add, update, remove, and list the members of a team." }, { "name": "Team Requests", "description": "Raise, list, accept, and reject requests to join a team." }, { "name": "Spaces", "description": "Create, read, duplicate, and update spaces, and resolve a user's role within them." }, { "name": "Space Members", "description": "Add, update, remove, and list the members of a space." }, { "name": "Space Requests", "description": "Raise, list, accept, and reject requests to join a space." }, { "name": "Zones", "description": "Create, duplicate, move, and update zones, read their metadata, and insert templates into them." }, { "name": "Zone Versions", "description": "Read the current version of a zone." }, { "name": "Conditional Sharing", "description": "Share individual zones within a space with a specific member." }, { "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." }, { "name": "Search", "description": "Search a team's content, zones, frames, comments, and members." }, { "name": "External Share", "description": "Publish, update, revoke, and inspect external shares." }, { "name": "Structured Creation", "description": "Create mindmaps, flowcharts, kanban boards, stacks, tables, and database tables in one call." }, { "name": "Anchoring", "description": "Place, align, and tidy frames and objects relative to one another, with feasibility previews." }, { "name": "Spatial Search", "description": "Query occupied and empty regions, clearances, and ranked placement candidates." }, { "name": "Connections", "description": "Create, re-route, and feasibility-check connectors between objects." }, { "name": "Relationships", "description": "Resolve parents, children, ancestors, descendants, and connected objects." }, { "name": "Traversal", "description": "Walk the zone in index, sequence, and windowed order." }, { "name": "Visual Navigation", "description": "Find adjacent elements, geometric distances, and visual ordering." }, { "name": "Tables", "description": "Insert and delete table rows and columns, merge cells, and read cell text." }, { "name": "Database Tables", "description": "Manage typed database_table columns, records, schema, and queries." }, { "name": "Text", "description": "Mutate and style text on any text-bearing object." }, { "name": "Data", "description": "Batch get, list, and update zones, frames, zone-slots, and objects." } ], "paths": { "/vani/api/v1/editions/{edition_id}/templates": { "get": { "summary": "Get the templates available in an edition", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ" ] } ], "operationId": "getTemplates", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "templates": [ { "name": "Eisenhower matrix", "description": "The Eisenhower Matrix, also known as the Urgent-Important Matrix, is a productivity tool used to prioritize tasks based on their urgency and importance.", "id": "2227813839241884264", "is_available_for_edition": "true" }, { "name": "1-on-1 feedback", "description": "Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.", "id": "415170746673786701", "is_available_for_edition": "true" }, { "name": "5 whys", "description": "Find the root cause of a problem by asking "Why?" questions.", "id": "8825346814681087568", "is_available_for_edition": "true" }, { "name": "Guess the Doodle", "description": "Just want to chill with the team for a while? This visual game will help you and your team relax and bond with each other.", "id": "7193564480716665813", "is_available_for_edition": "true" }, { "name": "Impact Effort Matrix", "description": "An impact effort matrix is a tool used in project management to help prioritize tasks based on their level of impact and effort required.", "id": "4880489140950000824", "is_available_for_edition": "true" }, { "name": "Customer problem statement", "description": "Get into your customer's shoes to better understand their problems. ", "id": "3570349084835838944", "is_available_for_edition": "true" }, { "name": "Marketing release checklist", "description": "Got an upcoming release? Here's an easier way to plan and execute\nyour marketing goals, so that you get everything covered.", "id": "5252159967532415789", "is_available_for_edition": "true" }, { "name": "Never Have I Ever", "description": "Never Have I Ever is a popular card game designed to reveal interesting and embarrassing secrets about the players. It's a great icebreaker and often opens up fun, entertaining conversations.", "id": "9068022063805355070", "is_available_for_edition": "true" }, { "name": "New teammate onboarding", "description": "Onboard new members of your team with this fun template.", "id": "8077947179536093903", "is_available_for_edition": "true" }, { "name": "New teammate project milestones", "description": "Help your new teammate understand all about your team's projects, the stuff they need to work on, and the expectations you've set for them.\r\n", "id": "2197960956629199196", "is_available_for_edition": "true" }, { "name": "Sales call follow-up", "description": "This is a quick way to share insights after a sales call and discuss them with your team.", "id": "1758538615716321335", "is_available_for_edition": "true" }, { "name": "Product positioning", "description": "Working on a new product or revising an existing one? Here are some positioning exercises for you and your teammates to brainstorm and fill in.\r\n", "id": "4786897632740503006", "is_available_for_edition": "true" }, { "name": "Strategic goal board", "description": "Chart out some goals and work together with your teammates towards achieving them.\r\n", "id": "146806559048094029", "is_available_for_edition": "true" }, { "name": "Team bookshelf", "description": "Build your team library with book recommendations from everyone.", "id": "2601700237097182900", "is_available_for_edition": "true" }, { "name": "Team coffee discussion", "description": "Bond with your team over coffee, or just about anything you want, and have fun discussions.", "id": "6282257423499599528", "is_available_for_edition": "true" }, { "name": "Team priority : Now, Next, Later", "description": "Working on your next team project? Quickly list down tasks and details, sort the most-important things to do, and keep track of the progress.\r\n", "id": "1189335149816408152", "is_available_for_edition": "true" }, { "name": "Team recipe board", "description": "A fun team activity to share the best and favorite recipes with each other.", "id": "709495071782421321", "is_available_for_edition": "true" }, { "name": "Website signup flow", "description": "A simple sign up flow to capture the visitor-to-subscriber conversion.", "id": "5772067647393374657", "is_available_for_edition": "true" }, { "name": "Weekly team planner", "description": "Plan your week with your teammates using this template.\r\n", "id": "3212028571933595674", "is_available_for_edition": "true" }, { "name": "Book Club Meeting", "description": "Use this template to jot down your bookish discussions and thoughts on what you are reading and keep track of your literary adventures. It is your cozy digital den for all things book-related.", "id": "2053719903222126011", "is_available_for_edition": "true" } ] }, "message": "Templates fetched successfully", "request_uri": "/vani/api/v1/editions/888012145/templates", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/Fields2" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Templates" ] } }, "/vani/api/v1/editions/{edition_id}/requests/status": { "get": { "summary": "Read whether access-request handling is switched on for the edition. Use to check the org-level toggle before a user tries to request access to a team or space.", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ" ] } ], "operationId": "getEditionRequestStatus", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Team Requests Enabled": { "value": { "data": { "edition_id": "96499735", "status": "true" }, "message": "Requests status fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/requests/status", "status": "success" } }, "Team Requests Disabled": { "value": { "data": { "edition_id": "80585907", "status": "false" }, "message": "Requests status fetched successfully", "request_uri": "/vani/api/v1/editions/80585907/requests/status", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Editions" ] }, "put": { "summary": "Approve or reject an edition join request", "security": [ { "iam-oauth2-schema": [ "Vani.editions.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditionRequestStatusRequest" } } } }, "operationId": "updateEditionRequestStatus", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Team Request Disabled": { "value": { "data": { "edition_id": "96499735", "status": "false" }, "message": "Requests status updated successfully", "request_uri": "/vani/api/v1/editions/96499735/requests/status", "status": "success" } }, "Team Request Enabled": { "value": { "data": { "edition_id": "96499735", "status": "true" }, "message": "Requests status updated successfully", "request_uri": "/vani/api/v1/editions/96499735/requests/status", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "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/112255940/requests/status", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Already in the Requested State": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "E1015", "message": "Team Request status is already in the requested state" } }, "request_uri": "/vani/api/v1/editions/96499735/requests/status", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Editions" ] } }, "/vani/api/v1/editions/{edition_id}/subscription": { "get": { "summary": "Get the edition's subscription details", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ" ] } ], "operationId": "getSubscription", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "TRAIL PLAN": { "value": { "data": { "subscription_info": { "plan_type": "Yearly", "edition_id": "112255940", "expiry_date": "Sat, 19 Jun 2027, 00:00:00", "members_count": "5", "purchase_date": "Fri, 19 Jun 2026, 18:56:49", "plan_name": "BUSINESS_PLAN", "status": "Active" } }, "message": "Subscription details fetched successfully", "request_uri": "/vani/api/v1/editions/112255940/subscription", "status": "success" } }, "Using Filter Fields": { "value": { "data": { "subscription_info": { "plan_type": "Yearly", "plan_name": "TEAM_PLAN", "status": "Active" } }, "message": "Subscription details fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/subscription", "status": "success" } }, "FREE PLAN": { "value": { "data": { "subscription_info": { "edition_id": "85572652", "expiry_date": "-1L", "purchase_date": "Mon, 24 Jun 2024, 11:44:23", "plan_name": "FREE_PLAN", "status": "Modified" } }, "message": "Subscription details fetched successfully", "request_uri": "/vani/api/v1/editions/85572652/subscription", "status": "success" } }, "PAID PLAN": { "value": { "data": { "subscription_info": { "plan_type": "Yearly", "edition_id": "96499735", "expiry_date": "Wed, 04 Feb 2026, 00:00:00", "purchase_date": "Tue, 04 Feb 2025, 00:51:12", "plan_name": "TEAM_PLAN", "status": "Active" } }, "message": "Subscription details fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/subscription", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "schema": { "type": "string", "maxLength": 1000, "enum": [ "status", "members_count", "edition_id", "purchase_date", "plan_name", "plan_type", "expiry_date" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: status, members_count, edition_id, purchase_date, plan_name, plan_type, expiry_date", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Subscription" ] } }, "/vani/api/v1/editions/{edition_id}": { "get": { "summary": "Get an edition", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ" ] } ], "operationId": "getEdition", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "edition_info": { "$ref": "#/components/schemas/EditionVO" } } } } } ] }, "examples": { "Using Filter Fields": { "value": { "data": { "edition_info": { "state": "ACTIVE", "edition_name": "QA TEAM", "edition_owner_id": "96384499" } }, "message": "Editions fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808", "status": "success" } }, "Success": { "value": { "data": { "edition_info": { "created_time": "Tue, 21 Jan 2025, 17:04:53", "last_modified_time": "Tue, 21 Jan 2025, 17:06:52", "edition_id": "97375109", "edition_type_name": "TEAM", "state": "ACTIVE", "edition_name": "QA TEAM", "edition_owner_id": "96384499", "uri": "/vani/api/v1/editions/97375109/teams" } }, "message": "Editions fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure – Invalid API Key": { "value": { "error": { "details": { "edition_id": "96499735", "error_code": "A1008", "message": "Given API Key is not valid." } }, "request_uri": "/vani/api/v1/editions/96499735", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/Fields7" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Editions" ] } }, "/vani/api/v1/editions/{edition_id}/templates/{template_id}": { "get": { "summary": "Get a template", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ" ] } ], "operationId": "getTemplate", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "template": { "name": "1-on-1 feedback", "description": "Help your mentor or teammate get an idea of what you're going to discuss with them in your 1-on-1 feedback sessions.", "id": "415170746673786701", "is_available_for_edition": "true" } }, "message": "Template fetched successfully", "request_uri": "/vani/api/v1/editions/888012145/templates/415170746673786701", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "Template not found": { "value": { "error": { "details": { "edition_id": "888012145", "current_user_id": "888015717", "error_code": "S1030", "message": "Template not found" } }, "request_uri": "/vani/api/v1/editions/888012145/templates/339360394209299546", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows500R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "schema": { "type": "string" }, "in": "path", "name": "template_id", "description": "The unique identifier of the template", "required": true }, { "$ref": "#/components/parameters/Fields2" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 500 }, "tags": [ "Templates" ] } }, "/vani/api/v1/editions": { "post": { "summary": "Create a new edition", "security": [ { "iam-oauth2-schema": [ "Vani.editions.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamRequest" } } } }, "operationId": "createEdition", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "98723605", "current_user_id": "98722154", "team_id": 5265000000002003, "team_name": "TeamEdition" }, "message": "Team edition created successfully", "request_uri": "/vani/api/v1/editions", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure: Invalid Parameter (team_name)": { "value": { "error": { "details": { "error_code": "IAM1031", "attribute": "team_name", "message": "The required parameter is missing" } }, "request_uri": "/vani/api/v1/editions", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Edition Already Created": { "value": { "error": { "details": { "current_user_id": "98722154", "error_code": "E1001", "message": "User has already created an edition" } }, "request_uri": "/vani/api/v1/editions", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows10Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 10 }, "tags": [ "Editions" ] }, "get": { "summary": "Get all editions the user belongs to", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ" ] } ], "operationId": "getEditions", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "editions_info": { "type": "array", "items": { "$ref": "#/components/schemas/EditionVO" } } } } } } ] }, "examples": { "Success: User Is Not Part of Any Edition": { "value": { "data": { "editions_info": {} }, "message": "Editions fetched successfully", "request_uri": "/vani/api/v1/editions", "status": "success" } }, "Using Filter Fields": { "value": { "data": { "editions_info": [ { "edition_name": "DEVELOPERS", "edition_owner_id": "69828190" }, { "edition_name": "REST API TEAM", "edition_owner_id": "96384499" }, { "edition_name": "QA TEAM", "edition_owner_id": "96384499" } ] }, "message": "Editions fetched successfully", "request_uri": "/vani/api/v1/editions", "status": "success" } }, "Success": { "value": { "data": { "editions_info": [ { "created_time": "Sun, 09 Apr 2023, 08:43:02", "last_modified_time": "Sun, 09 Apr 2023, 08:43:02", "edition_id": "75918186", "edition_type_name": "TEAM", "state": "ACTIVE", "edition_name": "DEVELOPERS", "edition_owner_id": "69828190", "is_default": "true", "uri": "/vani/api/v1/editions/75918186" }, { "created_time": "Fri, 03 Jan 2025, 11:55:58", "last_modified_time": "Wed, 29 Jan 2025, 18:26:53", "edition_id": "96499735", "edition_type_name": "TEAM", "state": "ACTIVE", "edition_name": "REST API TEAM", "edition_owner_id": "96384499", "uri": "/vani/api/v1/editions/96499735" }, { "created_time": "Tue, 21 Jan 2025, 17:04:53", "last_modified_time": "Tue, 21 Jan 2025, 17:06:52", "edition_id": "97375109", "edition_type_name": "TEAM", "state": "ACTIVE", "edition_name": "QA TEAM", "edition_owner_id": "96384499", "uri": "/vani/api/v1/editions/97375109" } ] }, "message": "Editions fetched successfully", "request_uri": "/vani/api/v1/editions", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/Fields7" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Editions" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/members": { "post": { "summary": "Add members to a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTeamMembersRequest" } } } }, "operationId": "createTeamMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "added_members": [ { "role_name": "MEMBER", "invited_time": "Mon, 03 Feb 2025, 23:17:12", "edition_id": "97375109", "mail_id": "sophia.bennett@boxicle.com", "added_by": "96384499", "team_id": "1505000000051031" } ] }, "message": "Team member added successfully.", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members", "status": "success" } } } } } }, "206": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "failed_members": [ { "error_message": "Member already invited", "mail_id": "sophia.bennett@boxicle.com", "error_code": "T1014" } ], "added_members": [ { "role_name": "MEMBER", "invited_time": "Mon, 03 Feb 2025, 23:16:13", "edition_id": "97375109", "mail_id": "olivia.morgan@boxicle.com", "added_by": "96384499", "team_id": "1505000000051031" }, { "role_name": "TEAM_ADMIN", "added_time": "Mon, 03 Feb 2025, 23:16:12", "mail_id": "liam.parker@boxicle.com", "added_by": "96384499", "team_id": "1505000000051031" } ] }, "message": "Partial success: Some members added, others failed.", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Member Already Part of the Team": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Member already part of team", "mail_id": "olivia.morgan@boxicle.com", "error_code": "T1013" } ], "error_code": "T1017", "message": "Team member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members", "status": "error" } }, "License Limit Reached": { "value": { "error": { "details": { "failed_members": [ { "error_message": "License limit reached", "error_code": "L1001" } ], "error_code": "T1017", "message": "Team member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "97377569", "error_code": "A1003", "team_id": "3009000000002003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Members" ] }, "get": { "summary": "Get the members of a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getTeamMembers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Pagination": { "value": { "data": { "team_members": [ { "role_name": "MEMBER", "added_time": "Tue, 21 Jan 2025, 13:29:58", "modified_time": "Tue, 21 Jan 2025, 13:29:58", "mail_id": "emma.carter@boxicle.com", "added_by": "85572741", "display_name": "Emma Carter", "zuid": "96384499" } ] }, "message": "Team members fetched successfully.", "request_uri": "/vani/api/v1/editions/75918186/teams/693000000450001/members", "status": "success" } }, "Using Filter Fields 2": { "value": { "data": { "team_admins": [ { "added_time": "Tue, 21 Jan 2025, 17:05:47", "mail_id": "ryan.mitchell@boxicle.com", "added_by": "96384499" } ] }, "message": "Team members fetched successfully.", "request_uri": "/vani/api/v1/editions/75918186/teams/693000000450001/members", "status": "success" } }, "Success 2": { "value": { "data": { "next_from": 1, "team_admins": [ { "role_name": "TEAM_ADMIN", "added_time": "Tue, 30 Sep 2025, 12:10:11", "modified_time": "Tue, 30 Sep 2025, 12:10:11", "mail_id": "user3@example.com", "added_by": "81864203", "display_name": "Sakthii5.2", "zuid": "82512958" } ] }, "message": "Team members fetched successfully.", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members", "status": "success" } }, "Using Filter Fields": { "value": { "data": { "team_members": [ { "added_time": "Tue, 21 Jan 2025, 13:29:58", "mail_id": "emma.carter@boxicle.com", "added_by": "85572741" }, { "added_time": "Sat, 30 Nov 2024, 22:32:11", "mail_id": "ryan.mitchell@boxicle.com", "added_by": "85572741" } ] }, "message": "Team members fetched successfully.", "request_uri": "/vani/api/v1/editions/75918186/teams/693000000450001/members", "status": "success" } }, "Success": { "value": { "data": { "next_from": 3, "team_members": [ { "role_name": "MEMBER", "added_time": "Thu, 14 May 2026, 20:34:50", "modified_time": "Thu, 14 May 2026, 20:34:50", "mail_id": "user1@example.com", "added_by": "82512958", "display_name": "Jayasree", "zuid": "64167940" }, { "role_name": "MEMBER", "added_time": "Thu, 04 Jun 2026, 20:51:19", "modified_time": "Wed, 24 Jun 2026, 16:46:50", "mail_id": "user2@example.com", "added_by": "82512958", "display_name": "sakthii corp", "zuid": "81864203" }, { "role_name": "TEAM_ADMIN", "added_time": "Tue, 30 Sep 2025, 12:10:11", "modified_time": "Tue, 30 Sep 2025, 12:10:11", "mail_id": "user3@example.com", "added_by": "81864203", "display_name": "Sakthii5.2", "zuid": "82512958" } ] }, "message": "Team members fetched successfully.", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "User Is Not Part of the Team": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1006", "team_id": "693000000008463", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000008463/members", "status": "error" } }, "User Is Not Part of the Team 2": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1006", "team_id": "693000000008463", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000008463/members", "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": { "Team Not Found 2": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1008", "team_id": "69300000045001", "message": "Team not found" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/69300000045001/members", "status": "error" } }, "Team Not Found": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1008", "team_id": "3009000000002003", "message": "Team not found" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/3009000000002003/members", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "schema": { "x-enumDescriptions": { "TEAM_GUEST": "A guest with limited access to the team.", "TEAM_ADMIN": "Can administer the team, including its members.", "MEMBER": "A regular member of the team." }, "type": "string", "enum": [ "TEAM_ADMIN", "MEMBER", "TEAM_GUEST" ] }, "in": "query", "name": "member_type", "description": "Role of the member to be fetched. The value TEAM_ADMIN retrieves only the team admins. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST", "required": false }, { "$ref": "#/components/parameters/SubscriberState" }, { "$ref": "#/components/parameters/Roles" }, { "schema": { "x-enumDescriptions": { "ROLE_DESC": "Sort by role, most privileged first.", "NAME_ASC": "Sort by name, A to Z.", "NAME_DESC": "Sort by name, Z to A.", "ROLE_ASC": "Sort by role, least privileged first." }, "type": "string", "enum": [ "ROLE_ASC", "ROLE_DESC", "NAME_ASC", "NAME_DESC" ] }, "in": "query", "name": "sort_by", "description": "Specifies the field used to sort the results. Allowed values: ROLE_ASC, ROLE_DESC, NAME_ASC, NAME_DESC", "required": false }, { "$ref": "#/components/parameters/Search" }, { "$ref": "#/components/parameters/Fields8" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Team Members" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/{member_id}": { "delete": { "summary": "Remove a member from a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.DELETE" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTeamMemberRequest" } } } }, "operationId": "deleteTeamMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "97375109", "removed_zuid": "97377569", "current_user_id": "96384499", "team_id": "1505000000051031" }, "message": "Team member deleted successfully.", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "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/112255940/teams/5777000000002017/members/80022267", "status": "error" } } } } } }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Super Admin Cannot Be Removed from the Team": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1004", "team_id": "3009000000002003", "message": "Super admin can't be removed from the team" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/members", "status": "error" } }, "Cannot Remove Self from the Team": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "M1002", "team_id": "5777000000002017", "message": "User cannot remove self" } }, "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members/82512958", "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": { "Member Not Part of the Team": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "T1012", "team_id": "1505000000051031", "message": "Member not part of team" } }, "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/MemberId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Members" ] }, "put": { "summary": "Update a team member's role", "security": [ { "iam-oauth2-schema": [ "Vani.teams.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamMemberRequest" } } } }, "operationId": "updateTeamMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success – Member Role Assigned": { "value": { "data": { "new_role": "MEMBER", "edition_id": "97375109", "current_user_id": "96384499", "team_id": "1505000000051031", "zuid": "98722154" }, "message": "Team member updated successfully.", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members", "status": "success" } }, "Success – Admin Role Assigned": { "value": { "data": { "new_role": "TEAM_ADMIN", "edition_id": "75918186", "current_user_id": "96384499", "team_id": "693000000436009", "zuid": "81479212" }, "message": "Team member updated successfully.", "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Non-Team Member Attempted Role Update": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1006", "team_id": "693000000436009", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1002", "team_id": "693000000436009", "message": "Only admin can do this action" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members", "status": "error" } } } } } }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Cannot Update Own Role": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "M1003", "team_id": "5777000000002017", "message": "Inactive user role cannot be updated", "zuid": "64167940" } }, "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members/64167940", "status": "error" } }, "Super Admin Role Cannot Be Updated": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "85572741", "error_code": "A1006", "team_id": "1505000000002005", "message": "Super admin can't be updated", "zuid": "96384499" } }, "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005/members", "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": { "Member Not Part of the Team": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "T1012", "team_id": "1505000000051031", "message": "Member not part of team", "zuid": "80215739" } }, "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000051031/members", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Member Already Has the Specified Role": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "M1001", "team_id": "693000000436009", "message": "The member already has the specified role", "zuid": "81479212" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/members", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/MemberId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Members" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/requests/my-requests": { "get": { "summary": "Get the current user's join requests for a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getTeamRequestMyRequests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "requests": { "status": "REQUESTED" } }, "message": "Team requests fetched successfully", "request_uri": "/vani/api/v1/editions/80473965/teams/1664000000002003/requests/my-requests", "status": "success" } }, "Success": { "value": { "data": { "requests": { "requested_time": "Wed, 06 Aug 2025, 12:35:45", "requested_by": "80473960", "request_id": "730000009272023", "status": "REQUESTED" } }, "message": "Team requests fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/my-requests", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "No Pending Request Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "R1007", "team_id": "3009000000002003", "message": "Team join request not found" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/my-requests", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Member Already Part of the Team": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "T1013", "team_id": "3009000000002003", "message": "Member already part of team" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/my-requests", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Fields3" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Requests" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}": { "get": { "summary": "Get a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getTeam", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "team": { "team_member_count": "5", "team_id": "1303000000002003", "created_by_name": "Dan", "team_name": "GraphZen" } }, "message": "Teams fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003", "status": "success" } }, "Success": { "value": { "data": { "team": { "created_time": "Tue, 28 May 2024, 15:34:44", "team_member_count": "5", "team_id": "1303000000002003", "created_by_name": "Dan", "zsoid": "60029715808", "created_by": "60029267674", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003/members", "team_name": "GraphZen" } }, "message": "Teams fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1006", "team_id": "693000000008463", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000008463", "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": { "Team Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "T1008", "team_id": "300900000000200", "message": "Team not found" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/300900000000200", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Fields" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Teams" ] }, "put": { "summary": "Update a team's name or settings", "security": [ { "iam-oauth2-schema": [ "Vani.teams.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.UPDATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamRequest" } } } }, "operationId": "updateTeam", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Description Update": { "value": { "data": { "edition_id": "97375109", "current_user_id": "96384499", "team_id": "1505000000002005", "new_description": "Visualize Graph Instantly" }, "message": "Team updated successfully", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005", "status": "success" } }, "Name Update": { "value": { "data": { "edition_id": "97375109", "current_user_id": "96384499", "team_id": "1505000000002005", "new_name": "GraphSnap" }, "message": "Team updated successfully", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005", "status": "success" } }, "Success": { "value": { "data": { "edition_id": "97375109", "current_user_id": "96384499", "team_id": "1505000000002005", "new_name": "GraphSnap", "new_description": "Visualize Graph Instantly" }, "message": "Team updated successfully", "request_uri": "/vani/api/v1/editions/97375109/teams/1505000000002005", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "Team Not Found": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "T1008", "team_id": "442100000000200", "message": "Team not found" } }, "request_uri": "/vani/api/v1/editions/97375109/teams/442100000000200", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Teams" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/requests/{request_id}/accept": { "post": { "summary": "Approve a pending team join request by request id and assign the requester a team role of TEAM_ADMIN, MEMBER or TEAM_GUEST. Admits them without a separate createTeamMember call.", "security": [ { "iam-oauth2-schema": [ "Vani.teams.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.CREATE" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptTeamRequestPayload" } } } }, "operationId": "acceptTeamRequest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success - TEAM MEMBER": { "value": { "data": { "role_name": "MEMBER", "edition_id": "112255940", "updated_at": "Fri, 21 Aug 2026, 20:04:43", "team_id": "5777000000002017", "request_id": "730000017057001", "zuid": "97049596", "status": "ACCEPTED" }, "message": "Team join request accepted successfully", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/requests/730000017057001/accept", "status": "success" } }, "Success - TEAM ADMIN": { "value": { "data": { "role_name": "TEAM_ADMIN", "edition_id": "96499735", "updated_at": "Wed, 06 Aug 2025, 00:54:48", "team_id": "3009000000002003", "request_id": "730000009261046", "zuid": "80473960", "status": "ACCEPTED" }, "message": "Team join request accepted successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261046/accept", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Invalid Request ID": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "R1003", "team_id": "3009000000002003", "message": "Invalid request ID" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "team_id": "3009000000002003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "License limit reached": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "L1001", "team_id": "3009000000002003", "message": "License limit reached" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept", "status": "error" } }, "Member Already Part of the Team": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "T1013", "team_id": "3009000000002003", "message": "Member already part of team" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/accept", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/RequestId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Requests" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/requests/{request_id}/reject": { "post": { "summary": "Decline a pending team join request by request id, leaving the requester outside the team. Use in place of acceptTeamRequest when access should not be granted.", "security": [ { "iam-oauth2-schema": [ "Vani.teams.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.CREATE" ] } ], "operationId": "rejectTeamRequest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "112255940", "updated_at": "Fri, 21 Aug 2026, 19:49:36", "team_id": "5777000000002017", "request_id": "730000017057001", "zuid": "97049596", "status": "REJECTED" }, "message": "Team join request rejected successfully", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/requests/730000017057001/reject", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Invalid Request ID": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "R1003", "team_id": "3009000000002003", "message": "Invalid request ID" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/73000000926104/reject", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "team_id": "3009000000002003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261019/reject", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Already Rejected": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "R1012", "team_id": "3009000000002003", "message": "Team join request is already rejected" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests/730000009261046/reject", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/RequestId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Requests" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/users/me/permission": { "get": { "summary": "Get the current user's role in a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getMyPermissionInTeam", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "user_permission_info": { "edition_id": "96499735", "role": "TEAM_ADMIN", "current_user_id": "96384499", "team_id": "3009000000002003" } }, "message": "User permissions fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/users/me/permission", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "User Is Not a Team Member": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1006", "team_id": "693000000002001", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000002001/users/me/permission", "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": { "Team Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "T1008", "team_id": "300900000002003", "message": "Team not found" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/300900000002003/users/me/permission", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Teams" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/requests": { "post": { "summary": "Raise a request for the calling user to join a team they cannot yet reach. A team admin then settles it with acceptTeamRequest or rejectTeamRequest.", "security": [ { "iam-oauth2-schema": [ "Vani.teams.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.CREATE" ] } ], "operationId": "createTeamRequest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "96499735", "updated_at": "Wed, 06 Aug 2025, 10:07:21", "team_id": "3009000000002003", "request_id": "730000009272001", "zuid": "80473960", "status": "PENDING" }, "message": "Team join request created successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Member Already Part of the Team": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "T1013", "team_id": "3009000000002003", "message": "Member already part of team" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "error" } }, "Request Already Exists": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "R1013", "team_id": "3009000000002003", "message": "Team join request already exists for the user" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Team Requests" ] }, "get": { "summary": "Get the join requests for a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getTeamRequests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "requests": [ { "name": "Emma Carter", "status": "REQUESTED" } ] }, "message": "Team requests fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "success" } }, "No Pending Join Requests": { "value": { "data": { "requests": [] }, "message": "Team requests fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "success" } }, "Success": { "value": { "data": { "requests": [ { "requested_time": "Wed, 06 Aug 2025, 12:35:45", "requested_by": "80473960", "name": "Emma Carter", "request_id": "730000009272023", "status": "REQUESTED" } ] }, "message": "Team requests fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1002", "team_id": "3009000000002003", "message": "Only admin can do this action" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/requests", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Fields3" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Team Requests" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/users/{user_id}/permission": { "get": { "summary": "Get a user's role in a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getTeamUserPermission", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Succcess": { "value": { "data": { "user_permission_info": { "edition_id": "96499735", "role": "TEAM_ADMIN", "current_user_id": "96384499", "team_id": "3009000000002003", "zuid": "80215739" } }, "message": "User permissions fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/users/80215739/permission", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "User Is Not a Team Member": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "T1006", "team_id": "3009000000002003", "message": "User is not a member of the team", "zuid": "80585905" } }, "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/users/80585905/permission", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1002", "team_id": "693000000436009", "message": "Only admin can do this action" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000436009/users/80585905/permission", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/UserId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Teams" ] } }, "/vani/api/v1/editions/{edition_id}/teams/users/me/permission": { "get": { "summary": "Get the current user's role across all teams", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getMyPermissionInAllTeams", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "user_permission_info": { "edition_id": "75918186", "teams": [ { "role": "TEAM_ADMIN", "team_id": 693000000435005 }, { "role": "MEMBER", "team_id": 693000000436009 }, { "role": "MEMBER", "team_id": 693000000450001 } ], "current_user_id": "96384499" } }, "message": "User permissions fetched successfully", "request_uri": "/vani/api/v1/editions/75918186/teams/users/me/permission", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "Invalid Edition": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "E1017", "message": "Invalid edition" } }, "request_uri": "/vani/api/v1/editions/02345/teams/users/me/permission", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Teams" ] } }, "/vani/api/v1/editions/{edition_id}/teams": { "get": { "summary": "Get all teams in an edition", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "getTeams", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Pagination with Sorting by Name (Ascending)": { "value": { "data": { "teams": [ { "created_time": "Wed, 12 Jun 2024, 11:22:30", "team_member_count": "8", "team_id": "1303000000003021", "created_by_name": "Alice", "zsoid": "60029715808", "created_by": "60029269987", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000003021", "team_name": "CloudSpark" }, { "created_time": "Tue, 28 May 2024, 15:34:44", "team_member_count": "5", "team_id": "1303000000002003", "is_default": "true", "created_by_name": "Dan", "zsoid": "60029715808", "created_by": "60029267674", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003", "team_name": "GraphZen" } ] }, "message": "Teams fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808/teams", "status": "success" } }, "Using Filter Fields": { "value": { "data": { "teams": [ { "team_member_count": "5", "team_id": "1303000000002003", "team_name": "GraphZen" }, { "team_member_count": "8", "team_id": "1303000000003021", "team_name": "CloudSpark" } ] }, "message": "Teams fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808/teams", "status": "success" } }, "Success : User in Organization, Not in Any Team": { "value": { "data": { "teams": [] }, "message": "User is not a member of any team", "request_uri": "/vani/api/v1/editions/98587682/teams", "status": "success" } }, "Pagination with Sorting by Created Time (Descending)": { "value": { "data": { "teams": [ { "created_time": "Wed, 12 Jun 2024, 11:22:30", "team_member_count": "8", "team_id": "1303000000003021", "created_by_name": "Alice", "zsoid": "60029715808", "created_by": "60029269987", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000003021", "team_name": "CloudSpark" }, { "created_time": "Tue, 28 May 2024, 15:34:44", "team_member_count": "5", "team_id": "1303000000002003", "is_default": "true", "created_by_name": "Dan", "zsoid": "60029715808", "created_by": "60029267674", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003", "team_name": "GraphZen" } ] }, "message": "Teams fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808/teams", "status": "success" } }, "Success": { "value": { "data": { "teams": [ { "created_time": "Tue, 28 May 2024, 15:34:44", "team_member_count": "5", "team_id": "1303000000002003", "is_default": "true", "created_by_name": "Dan", "zsoid": "60029715808", "created_by": "60029267674", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000002003", "team_name": "GraphZen" }, { "created_time": "Wed, 12 Jun 2024, 11:22:30", "team_member_count": "8", "team_id": "1303000000003021", "created_by_name": "Alice", "zsoid": "60029715808", "created_by": "60029269987", "uri": "/vani/api/v1/editions/60029715808/teams/1303000000003021", "team_name": "CloudSpark" } ] }, "message": "Teams fetched successfully", "request_uri": "/vani/api/v1/editions/60029715808/teams", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/Fields" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "x-enumDescriptions": { "created_time": "Sort by creation time.", "name": "Sort by team name." }, "type": "string", "enum": [ "name", "created_time" ] }, "in": "query", "name": "sort_by", "description": "Specifies the field used to sort the results. Allowed values: name, created_time", "required": false }, { "schema": { "x-enumDescriptions": { "asc": "Ascending order.", "desc": "Descending order." }, "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "order_by", "description": "Specifies the sorting order. Allowed values: asc, desc", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Teams" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/duplicate": { "post": { "summary": "Duplicate a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DuplicateSpaceRequest" } } } }, "operationId": "duplicateSpace", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Space Duplicated with Deep Copy": { "value": { "data": { "space_info": { "created_time": "Sat, 08 Mar 2025, 17:40:07", "last_modified_time": "Sat, 08 Mar 2025, 17:40:07", "is_favorite": "false", "space_name": "Vision board - 1", "publish": "false", "owner_zuid": "80215739", "can_edit": "true", "team_id": "3009000000002003", "allow_embed": "false", "space_id": "3009000000239341", "last_author_zuid": "80215739", "status": "ACTIVE" } }, "message": "Space duplicated successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate", "status": "success" } }, "Space Duplicated in a Different Team": { "value": { "data": { "space_info": { "created_time": "Sat, 08 Mar 2025, 17:37:07", "last_modified_time": "Sat, 08 Mar 2025, 17:37:07", "is_favorite": "false", "space_name": "Vision board", "publish": "false", "owner_zuid": "80215739", "can_edit": "true", "team_id": "3009000000002003", "allow_embed": "false", "space_id": "3009000000239335", "last_author_zuid": "80215739", "status": "ACTIVE" } }, "message": "Space duplicated successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate", "status": "success" } }, "Space Duplicated with Members and Comments": { "value": { "data": { "space_info": { "created_time": "Sat, 08 Mar 2025, 17:37:07", "last_modified_time": "Sat, 08 Mar 2025, 17:37:07", "is_favorite": "false", "space_name": "Vision board", "publish": "false", "owner_zuid": "80215739", "can_edit": "true", "team_id": "3009000000002003", "allow_embed": "false", "space_id": "3009000000239335", "last_author_zuid": "80215739", "status": "ACTIVE" } }, "message": "Space duplicated successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate", "status": "success" } }, "Space Duplicated Without New Space Name": { "value": { "data": { "space_info": { "created_time": "Sat, 08 Mar 2025, 18:12:41", "is_favorite": "false", "last_modified_time": "Sat, 08 Mar 2025, 18:12:41", "space_name": "Copy of Social media strategy and planning", "publish": "false", "owner_zuid": "80215739", "can_edit": "true", "allow_embed": "false", "team_id": "3009000000002003", "space_id": "3009000000239843", "last_author_zuid": "80215739", "status": "ACTIVE" } }, "message": "Space duplicated successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000232005/duplicate", "status": "success" } }, "Success": { "value": { "data": { "space_info": { "created_time": "Fri, 21 Aug 2026, 19:38:07", "last_modified_time": "Fri, 21 Aug 2026, 19:38:07", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000917103", "team_id": "5777000000002017", "allow_embed": "false", "space_name": "Vision board", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000917103", "last_author_zuid": "82512958", "status": "ACTIVE" } }, "message": "Space duplicated successfully", "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000911002/duplicate", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80215739", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000093003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/duplicate", "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": { "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80215739", "error_code": "S1009", "message": "Space not found", "space_id": "300900000093003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000093003/duplicate", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}": { "get": { "summary": "Get a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpace", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "space_info": { "$ref": "#/components/schemas/ProjectVO" } } } } } ] }, "examples": { "Using Filter Fields": { "value": { "data": { "space_info": { "is_favorite": "false", "can_edit": "true", "team_id": "1303000000002003" } }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/60029715808/spaces/1303000000492291", "status": "success" } }, "Success": { "value": { "data": { "space_info": { "created_time": "Fri, 21 Aug 2026, 18:25:57", "last_modified_time": "Fri, 21 Aug 2026, 18:34:26", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000911002", "team_id": "5777000000002017", "allow_embed": "false", "space_member_count": "1", "space_name": "REST API Doc Space", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000911002", "last_author_zuid": "82512958", "status": "ACTIVE" } }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000911002", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000009300", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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/Fields6" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/requests": { "post": { "summary": "Raise a request to join a space", "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/AcceptSpaceRequestPayload" } } } }, "operationId": "createSpaceRequest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Role Update Request Created": { "value": { "data": { "edition_id": "96499735", "updated_at": "Wed, 06 Aug 2025, 10:12:18", "request_id": "3009000000793049", "space_id": "3009000000694083", "zuid": "80473960", "status": "PENDING" }, "message": "Space join request created successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "status": "success" } }, "Success": { "value": { "data": { "edition_id": "96499735", "updated_at": "Wed, 06 Aug 2025, 05:07:43", "request_id": "3009000000777009", "space_id": "3009000000694083", "zuid": "80473960", "status": "PENDING" }, "message": "Space join request created successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Downgrade is not allowed": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "R1011", "message": "Requesting for downgrade is not allowed" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "status": "error" } }, "Cannot Update Owner Role": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1004", "message": "Cannot update owner role" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "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": { "Member Not Part of the Team": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "T1012", "message": "Member not part of team" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Member Already Has the Specified Role": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "M1001", "message": "The member already has the specified role" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Requests" ] }, "get": { "summary": "Get the join requests for a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaceRequests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "success": { "value": { "data": { "requests": [ { "requested_time": "Wed, 06 Aug 2025, 16:05:37", "requested_by": "80215739", "role": "VIEWER", "name": "naga.vg", "request_id": "3009000000789151", "status": "PENDING" }, { "requested_time": "Wed, 06 Aug 2025, 16:10:51", "requested_by": "80473960", "role": "VIEWER", "name": "naga.vg", "request_id": "3009000000789147", "status": "PENDING" } ] }, "message": "Space join requests fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000701079/requests", "status": "success" } }, "No Pending Join Requests": { "value": { "data": { "requests": [] }, "message": "Space join requests fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "A1003", "team_id": "3009000000694083", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests", "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": { "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1009", "team_id": "300900000064083", "message": "Space not found" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000064083/requests", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/Fields4" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Requests" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/users/me/permission": { "get": { "summary": "Get the current user's role in a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getMyPermissionInSpace", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "user_permission_info": { "edition_id": "96499735", "role": "CREATOR", "current_user_id": "96384499", "space_id": "3009000000093003" } }, "message": "User permissions fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/users/me/permission", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "User Is Not a Space Member": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1015", "message": "Member is not part of the Space", "space_id": "3009000000298005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000298005/users/me/permission", "status": "error" } }, "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1009", "message": "Space not found", "space_id": "300900000093003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000093003/users/me/permission", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/requests/{request_id}/accept": { "post": { "summary": "Accept a request to join a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "operationId": "acceptSpaceRequest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "role_name": "VIEWER", "edition_id": "96499735", "updated_at": "Wed, 06 Aug 2025, 20:07:20", "request_id": "3009000000789147", "space_id": "3009000000701079", "zuid": "80473960", "status": "ACCEPTED" }, "message": "Space join request accepted successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000701079/requests/3009000000789147/accept", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Invalid Request Id": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "R1003", "team_id": "3009000000694083", "message": "Invalid request ID" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777013/accept", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "A1003", "team_id": "3009000000694083", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777109/accept", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/RequestId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Requests" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/members/{member_id}": { "delete": { "summary": "Remove a member from a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.DELETE" ] } ], "operationId": "deleteSpaceMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "97375109", "removed_zuid": "80473960", "current_user_id": "96384499", "space_id": "1505000000039107" }, "message": "Space member deleted successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000039107/members", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "1505000000045043" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000045043/members", "status": "error" } } } } } }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure : Space owner cannot be removed": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "S1002", "message": "Space owner cannot be removed", "space_id": "1505000000045043" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000045043/members", "status": "error" } }, "Failure : Cannot remove self": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "M1002", "message": "User cannot remove self", "space_id": "1505000000045043" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000045043/members/96384499", "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": { "Failure : Member Not in Space": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "S1015", "message": "Member is not part of the Space", "space_id": "1505000000039107" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000039107/members", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/MemberId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Members" ] }, "put": { "summary": "Update a space member's role", "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/UpdateSpaceMemberRequest" } } } }, "operationId": "updateSpaceMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success: Role Updated to Editor": { "value": { "data": { "new_role": "EDITOR", "edition_id": "97375109", "current_user_id": "96384499", "space_id": "1505000000005005", "zuid": "80473960" }, "message": "Space member updated successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000005005/members", "status": "success" } }, "Success: Role Updated to Commenter": { "value": { "data": { "new_role": "COMMENTER", "edition_id": "97375109", "current_user_id": "96384499", "space_id": "1505000000005005", "zuid": "80473960" }, "message": "Space member updated successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000005005/members", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "693000000536005" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000536005/members", "status": "error" } } } } } }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure: Cannot Update Own Role": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "R1001", "message": "Cannot update own role", "space_id": "1505000000045043", "zuid": "96384499" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000045043/members", "status": "error" } }, "Failure: Cannot Update Owner Role": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "S1004", "message": "Cannot update owner role", "space_id": "1505000000045043", "zuid": "80473960" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000045043/members", "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": { "Failure: Member Not Part of the Space": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1015", "message": "Member is not part of the Space", "space_id": "3009000000067027", "zuid": "80585905" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000067027/members", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure: Member Already Has the Same Role": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "M1001", "message": "The member already has the specified role", "space_id": "1505000000005005", "zuid": "80473960" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000005005/members/80473960", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/MemberId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Members" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/requests/my-requests": { "get": { "summary": "Get the current user's join requests for a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaceRequestMyRequests", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "requests": { "requested_time": "Wed, 06 Aug 2025, 16:10:51", "requested_by": "80473960", "role": "VIEWER", "request_id": "3009000000789147", "status": "PENDING" } }, "message": "Space join request fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000701079/requests/my-requests", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "Request Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "R1014", "team_id": "3009000000694083", "message": "Space join request not found" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/my-requests", "status": "error" } }, "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "S1009", "team_id": "1664000000180003", "message": "Space not found" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/1664000000180003/requests/my-requests", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/Fields4" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Requests" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/requests/{request_id}/reject": { "post": { "summary": "Reject a request to join a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "operationId": "rejectSpaceRequest", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "112255940", "updated_at": "Fri, 21 Aug 2026, 20:10:08", "request_id": "5777000000922022", "space_id": "5777000000919096", "zuid": "97049596", "status": "REJECTED" }, "message": "Space join request rejected successfully", "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000919096/requests/5777000000922022/reject", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "80473960", "error_code": "A1003", "team_id": "3009000000694083", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777117/reject", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Already Rejected": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "R1015", "team_id": "3009000000694083", "message": "Space join request is already rejected" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000694083/requests/3009000000777117/reject", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/RequestId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Requests" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/users/{user_id}/permission": { "get": { "summary": "Get a user's role in a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaceUserPermission", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "user_permission_info": { "edition_id": "96499735", "role": "EDITOR", "current_user_id": "96384499", "space_id": "3009000000303003", "zuid": "80215739" } }, "message": "User permissions fetched successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/users/80215739/permission", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1020", "message": "User is not the owner of the Space", "space_id": "3009000000298005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000298005/users/80215739/permission", "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": { "User Is Not a Space Member": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1015", "message": "Member is not part of the Space", "space_id": "3009000000303003", "zuid": "80215739" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/users/80215739/permission", "status": "error" } } } } } }, "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/UserId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/meta": { "put": { "summary": "Update space metadata", "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/UpdateSpaceMetaRequest" } } } }, "operationId": "updateSpaceMeta", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success: Removed from Favorites": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "is_favourite": false, "space_id": "3009000000141003" }, "message": "Space meta updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta", "status": "success" } }, "Success: Marked as Embedded": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "space_id": "3009000000093003", "embed_status": true }, "message": "Space meta updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta", "status": "success" } }, "Success: Embed Removed": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "space_id": "3009000000093003", "embed_status": false }, "message": "Space meta updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta", "status": "success" } }, "Success": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "space_id": "3009000000141003", "new_name": "Never Have | Ever" }, "message": "Space meta updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta", "status": "success" } }, "Success: Marked as Favorite": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "is_favourite": true, "space_id": "3009000000141003" }, "message": "Space meta updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized 2": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "300900000014100" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000014100/meta", "status": "error" } }, "Unauthorized 3": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000220049" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000220049/meta", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000141003" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/3009000000141003/meta", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure: Unable to Remove from Favorites": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1018", "message": "Space is not favourite", "space_id": "3009000000141003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta", "status": "error" } }, "Same Space Name Exists": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1014", "message": "Space name is same as the new name", "space_id": "3009000000141003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta", "status": "error" } }, "Failure: Unable to Mark as Favorite": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1017", "message": "Space is already favourite", "space_id": "3009000000141003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/meta", "status": "error" } }, "Failure: Unable to Remove Embed": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1022", "message": "Space is not in an embedded state", "space_id": "3009000000093003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta", "status": "error" } }, "Failure: Unable to Mark as Embedded": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1021", "message": "Space is already in an embedded state", "space_id": "3009000000093003" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093003/meta", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/members": { "post": { "summary": "Add members to a space", "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/AddSpaceMembersRequest" } } } }, "operationId": "createSpaceMembers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success: All User Types": { "value": { "data": { "added_members": [ { "role_name": "VIEWER", "added_type_name": "USER", "added_time": "Tue, 04 Feb 2025, 11:18:40", "mail_id": "lucas.bryant@boxicle.com", "added_by": "96384499", "display_name": "Lucas Bryant", "zuid": "98722154" }, { "role_name": "EDITOR", "added_type_name": "TEAM", "added_time": "Tue, 04 Feb 2025, 11:18:40", "added_by": "96384499", "display_name": "TEAM VANI", "zuid": "1505000000002005" } ] }, "message": "Space member added successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000039170/members", "status": "success" } }, "Success with Conditional Sharing": { "value": { "data": { "added_members": [ { "added_type_name": "USER", "added_time": "Mon, 28 Jul 2025, 02:23:54", "mail_id": "sophia.bennett@boxicle.com", "added_by": "888015717", "display_name": "Sophia Bennett", "zuid": "98722154" } ] }, "message": "Space member added successfully.", "request_uri": "/vani/api/v1/editions/888012145/spaces/4855000000088149/members", "status": "success" } }, "Success": { "value": { "data": { "added_members": [ { "role_name": "VIEWER", "added_type_name": "USER", "added_time": "Tue, 04 Feb 2025, 10:26:17", "mail_id": "sophia.bennett@boxicle.com", "added_by": "96384499", "display_name": "Sophia Bennett", "zuid": "98722154" } ] }, "message": "Space member added successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000039170/members", "status": "success" } } } } } }, "206": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "failed_members": [ { "error_message": "Member already part of Space", "error_code": "S1019", "zuid": "98722154" } ], "added_members": [ { "role_name": "EDITOR", "added_type_name": "TEAM", "added_time": "Tue, 04 Feb 2025, 11:14:23", "added_by": "96384499", "display_name": "CloudSpark", "zuid": "1505000000002005" } ] }, "message": "Partial success: Some members added, others failed.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000039170/members", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Not Part of the Team": { "value": { "error": { "details": { "failed_members": [ { "error_message": "User is inactive and cannot be added to project", "error_code": "U1001", "zuid": "80215739" } ], "error_code": "S1008", "message": "Space member add failed" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000536104/members", "status": "error" } }, "Partial Access Is Not Allowed for Free Plan": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Partial access is not allowed for free plan", "error_code": "Z1016", "zuid": "1373000000002001" } ], "error_code": "S1008", "message": "Space member add failed" } }, "request_uri": "/vani/api/v1/editions/80585907/spaces/1373000000696005/members", "status": "error" } }, "Cannot Set Full Access with Restrictions": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Restricting full access conflicts with existing permissions", "error_code": "Z1015", "zuid": "3009000000002003" } ], "error_code": "S1008", "message": "Space member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/members", "status": "error" } }, "User Not Part of the Team or Edition": { "value": { "error": { "details": { "failed_members": [ { "error_message": "User is inactive and cannot be added to project", "error_code": "U1001", "zuid": "80215739" } ], "error_code": "S1008", "message": "Space member add failed" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000536104/members", "status": "error" } }, "Already Part of Space": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Member already part of Space", "error_code": "S1019", "zuid": "98722154" } ], "error_code": "S1008", "message": "Space member add failed" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000039170/members", "status": "error" } }, "Private Sharing Is Restricted for Free Plan": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Private share is restricted for free plan", "error_code": "Z1014", "zuid": "80215739" } ], "error_code": "S1008", "message": "Space member add failed" } }, "request_uri": "/vani/api/v1/editions/80585907/spaces/1373000000696005/members", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "300900000014503" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000014503/members", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Space Members" ] }, "get": { "summary": "Get the members of a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaceMembers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "space_members": [ { "role_name": "EDITOR", "display_name": "Emma Carter", "zuid": "80473960" }, { "role_name": "VIEWER", "display_name": "CloudSpark", "zuid": "1505000000002005" }, { "role_name": "CREATOR", "display_name": "Ryan Mitchell", "zuid": "96384499" } ] }, "message": "Space members fetched successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/members", "status": "success" } }, "Success": { "value": { "data": { "space_members": [ { "role_name": "CREATOR", "added_type_name": "USER", "added_time": "Fri, 21 Aug 2026, 18:25:57", "mail_id": "user3@example.com", "added_by": "82512958", "display_name": "Sakthii5.2", "zuid": "82512958" } ], "next_from": 1 }, "message": "Space members fetched successfully.", "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000911002/members", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "300900000038005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000038005/members", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "schema": { "x-enumDescriptions": { "EDITOR": "Can view and edit the contents of the space.", "VIEWER": "Can view the space only.", "CREATOR": "The member who created the space.", "COMMENTER": "Can view the space and add comments, but not edit it.", "ORGANISER": "Can administer the space, including its members and sharing." }, "type": "string", "enum": [ "CREATOR", "EDITOR", "COMMENTER", "VIEWER", "ORGANISER" ] }, "in": "query", "name": "roles", "description": "Parameter: roles. Allowed values: CREATOR, EDITOR, COMMENTER, VIEWER, ORGANISER", "required": false }, { "schema": { "x-enumDescriptions": { "ROLE_DESC": "Sort by role, most privileged first.", "ROLE_ASC": "Sort by role, least privileged first." }, "type": "string", "enum": [ "ROLE_ASC", "ROLE_DESC" ] }, "in": "query", "name": "sort_by", "description": "Specifies the field used to sort the results. Allowed values: ROLE_ASC, ROLE_DESC", "required": false }, { "$ref": "#/components/parameters/Search" }, { "schema": { "type": "string", "maxLength": 1000, "enum": [ "added_type_name", "display_name", "zuid", "added_time", "mail_id", "role_name", "added_by" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: added_type_name, display_name, zuid, added_time, mail_id, role_name, added_by", "required": false }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Space Members" ] } }, "/vani/api/v1/editions/{edition_id}/spaces": { "post": { "summary": "Create a new space", "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/CreateSpaceRequest" } } } }, "operationId": "createSpace", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Create Space Using Template": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "space_id": "3009000000145003", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000145003" }, "message": "Space created successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/", "status": "success" } }, "Success": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "space_id": "3009000000141003", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003" }, "message": "Space created successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "T1006", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/", "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": { "Template Not Found": { "value": { "error": { "details": { "edition_id": "60029715808", "current_user_id": "60029267674", "error_code": "S1030", "message": "Template not found" } }, "request_uri": "/vani/api/v1/editions/60029715808/spaces/", "status": "error" } }, "Team Not Found": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "T1008", "message": "Team not found" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spaces" ] }, "get": { "summary": "Get all spaces in an edition", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaces", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "type": "object", "properties": { "spaces_info": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectVO" } } } } } } ] }, "examples": { "A_T - FAVOURITES": { "value": { "data": { "space_count": 1, "spaces_info": [ { "created_time": "Fri, 24 Jan 2025, 12:25:29", "last_modified_time": "Fri, 24 Jan 2025, 12:25:29", "is_favorite": "true", "space_name": "Business case template", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "1", "space_id": "3009000000093779", "last_author_zuid": "96384499", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - RECENT_ALL_SPACES_ORG": { "value": { "data": { "space_count": 2, "spaces_info": [ { "created_time": "Fri, 17 Jan 2025, 12:00:57", "last_modified_time": "Fri, 17 Jan 2025, 12:40:05", "is_favorite": "false", "space_name": "testing library", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "0", "space_id": "3009000000038005", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Fri, 03 Jan 2025, 11:55:58", "last_modified_time": "Fri, 03 Jan 2025, 11:57:14", "is_favorite": "false", "space_name": "Vani - Getting Started", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "0", "space_id": "3009000000002013", "last_author_zuid": "96384499", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - RECENTLY_TRASHED": { "value": { "data": { "space_count": 2, "spaces_info": [ { "created_time": "Fri, 24 Jan 2025, 12:26:26", "last_modified_time": "Fri, 24 Jan 2025, 12:26:26", "is_favorite": "false", "space_name": "trash 1", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "state_modified_time": "Fri, 24 Jan 2025, 12:26:36", "space_id": "3009000000093854", "last_author_zuid": "96384499", "status": "TRASH" }, { "created_time": "Fri, 24 Jan 2025, 12:26:46", "last_modified_time": "Fri, 24 Jan 2025, 12:26:46", "is_favorite": "false", "space_name": "trash 2", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "state_modified_time": "Fri, 24 Jan 2025, 12:26:51", "space_id": "3009000000093930", "last_author_zuid": "96384499", "status": "TRASH" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "Using Filter Fields": { "value": { "data": { "space_count": 58, "spaces_info": [ { "space_name": "Business case template", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "Customer journey map", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "Project", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "New Space", "owner_zuid": "97377569", "space_member_count": "2" }, { "space_name": "New Space", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "New Space", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "New Space", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "New Space", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "New Space", "owner_zuid": "96384499", "space_member_count": "1" }, { "space_name": "New Space", "owner_zuid": "96384499", "space_member_count": "1" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - SHARED_SPACES": { "value": { "data": { "space_count": 4, "spaces_info": [ { "created_time": "Wed, 22 Jan 2025, 01:17:29", "last_modified_time": "Wed, 22 Jan 2025, 01:17:29", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "97377569", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "3", "space_id": "3009000000058037", "last_author_zuid": "97377569", "status": "ACTIVE" }, { "created_time": "Fri, 24 Jan 2025, 00:01:19", "last_modified_time": "Fri, 24 Jan 2025, 00:01:19", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "2", "space_id": "3009000000093003", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Wed, 22 Jan 2025, 00:44:10", "last_modified_time": "Wed, 22 Jan 2025, 00:44:10", "is_favorite": "false", "space_name": "project members test", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "3", "space_id": "3009000000067027", "last_author_zuid": "96384499", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - SHARED_BY_OTHERS": { "value": { "data": { "space_count": 1, "spaces_info": [ { "created_time": "Wed, 22 Jan 2025, 01:17:29", "last_modified_time": "Wed, 22 Jan 2025, 01:17:29", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "97377569", "can_edit": "false", "team_id": "3009000000002003", "space_member_count": "3", "space_id": "3009000000058037", "last_author_zuid": "97377569", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - PUBLISHED_WITH_TEAM": { "value": { "data": { "space_count": 2, "spaces_info": [ { "created_time": "Fri, 17 Jan 2025, 12:00:57", "last_modified_time": "Fri, 17 Jan 2025, 12:40:05", "is_favorite": "false", "space_name": "testing library", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "0", "space_id": "3009000000038005", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Fri, 03 Jan 2025, 11:55:58", "last_modified_time": "Fri, 03 Jan 2025, 11:57:14", "is_favorite": "false", "space_name": "Vani - Getting Started", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "0", "space_id": "3009000000002013", "last_author_zuid": "96384499", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - SHARED_BY_ME": { "value": { "data": { "space_count": 3, "spaces_info": [ { "created_time": "Fri, 24 Jan 2025, 00:01:19", "last_modified_time": "Fri, 24 Jan 2025, 00:01:19", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_member_count": "2", "space_id": "3009000000093003", "last_author_zuid": "96384499", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - DRAFT_SPACES": { "value": { "data": { "space_count": 24, "spaces_info": [ { "created_time": "Fri, 24 Jan 2025, 12:25:29", "last_modified_time": "Fri, 24 Jan 2025, 12:25:29", "is_favorite": "true", "space_name": "Business case template", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000093779", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Fri, 24 Jan 2025, 12:25:24", "last_modified_time": "Fri, 24 Jan 2025, 12:25:24", "is_favorite": "false", "space_name": "Customer journey map", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000093710", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Wed, 22 Jan 2025, 21:42:57", "last_modified_time": "Wed, 22 Jan 2025, 21:42:57", "is_favorite": "false", "space_name": "GET PROJECT TEST", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000090062", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Mon, 27 Jan 2025, 22:07:24", "last_modified_time": "Mon, 27 Jan 2025, 22:07:24", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000098042", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Mon, 27 Jan 2025, 22:13:00", "last_modified_time": "Mon, 27 Jan 2025, 22:13:00", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000100003", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Mon, 27 Jan 2025, 22:13:35", "last_modified_time": "Mon, 27 Jan 2025, 22:13:35", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000100067", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Mon, 27 Jan 2025, 22:14:52", "last_modified_time": "Mon, 27 Jan 2025, 22:14:52", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000100187", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Mon, 27 Jan 2025, 22:17:19", "last_modified_time": "Mon, 27 Jan 2025, 22:17:19", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000100307", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Tue, 28 Jan 2025, 20:22:52", "last_modified_time": "Tue, 28 Jan 2025, 21:39:33", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000111003", "last_author_zuid": "96384499", "status": "ACTIVE" }, { "created_time": "Wed, 29 Jan 2025, 17:43:08", "last_modified_time": "Wed, 29 Jan 2025, 17:43:08", "is_favorite": "false", "space_name": "New Space", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "team_id": "3009000000002003", "space_id": "3009000000126009", "last_author_zuid": "96384499", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces", "status": "success" } }, "A_T - ALL_SPACES": { "value": { "data": { "space_count": 25, "spaces_info": [ { "created_time": "Tue, 30 Sep 2025, 13:07:54", "last_modified_time": "Fri, 03 Jul 2026, 19:51:24", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000027003", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP AUTH", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000027003", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Thu, 20 Aug 2026, 11:18:56", "last_modified_time": "Thu, 20 Aug 2026, 11:29:46", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000904056", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP Connector CURVE to LINE Test 2026-08-20", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000904056", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Thu, 20 Aug 2026, 08:38:38", "last_modified_time": "Thu, 20 Aug 2026, 09:21:47", "is_favorite": "true", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000899002", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP Full Suite Regression 2026-08-20", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000899002", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Thu, 20 Aug 2026, 10:57:26", "last_modified_time": "Thu, 20 Aug 2026, 11:30:13", "is_favorite": "true", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000899158", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP Full Suite Run B 2026-08-20 (renamed)", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000899158", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Tue, 14 Jul 2026, 16:24:35", "last_modified_time": "Tue, 14 Jul 2026, 19:20:14", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000831044", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP issue find", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000831044", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Thu, 20 Aug 2026, 09:13:46", "last_modified_time": "Thu, 20 Aug 2026, 09:13:46", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000899063", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP Suite Moved Zone Target", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000899063", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Thu, 20 Aug 2026, 11:04:26", "last_modified_time": "Thu, 20 Aug 2026, 11:04:26", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000899181", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP Suite NewSpace From Zone", "publish": "false", "owner_zuid": "82512958", "state_modified_time": "Thu, 20 Aug 2026, 11:39:08", "space_id": "5777000000899181", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Thu, 20 Aug 2026, 09:19:24", "last_modified_time": "Thu, 20 Aug 2026, 09:19:24", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000899115", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "MCP Suite Space Copy", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000899115", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Tue, 30 Sep 2025, 12:11:09", "last_modified_time": "Tue, 30 Sep 2025, 12:11:09", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000022031", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "New Space", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000022031", "last_author_zuid": "82512958", "status": "ACTIVE" }, { "created_time": "Mon, 13 Oct 2025, 18:08:43", "last_modified_time": "Mon, 13 Oct 2025, 18:10:13", "is_favorite": "false", "can_edit": "true", "open_url": "https://app.localvanihq.net/edition/112255940/space/5777000000033005", "team_id": "5777000000002017", "space_member_count": "1", "space_name": "New Space", "publish": "false", "owner_zuid": "82512958", "space_id": "5777000000033005", "last_author_zuid": "82512958", "status": "ACTIVE" } ] }, "message": "Space fetched successfully.", "request_uri": "/vani/api/v1/editions/112255940/spaces", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "schema": { "type": "string" }, "in": "query", "name": "team_id", "description": "The ID of the team within the edition", "required": false }, { "schema": { "x-enumDescriptions": { "PUBLISHED_WITH_ORG": "Spaces published to the whole organisation.", "RECENTLY_TRASHED_SPACES": "Recently trashed Spaces", "ALL_SPACES": "All Spaces within the edition", "DRAFT_SPACES": "Spaces that are in draft", "SHARED_SPACES": "Spaces shared with you", "SHARED_BY_OTHERS": "Spaces shared by others with you", "FAVOURITES": "Spaces the user has marked as a favourite.", "RECENT_ALL_SPACES_ORG": "Recently opened spaces from anywhere in the edition.", "RECENTLY_TRASHED_ZONES": "Recently trashed zones only.", "NON_TEAM_MEMBER_SHARED_SPACE": "Spaces shared with the user from a team they do not belong to.", "PUBLISHED_WITH_TEAM": "Spaces published with the team", "SHARED_BY_ME": "Spaces you’ve shared", "RECENTLY_TRASHED": "Recently trashed spaces and zones together." }, "type": "string", "enum": [ "ALL_SPACES", "SHARED_SPACES", "SHARED_BY_ME", "SHARED_BY_OTHERS", "PUBLISHED_WITH_TEAM", "PUBLISHED_WITH_ORG", "FAVOURITES", "DRAFT_SPACES", "RECENT_ALL_SPACES_ORG", "RECENTLY_TRASHED_SPACES", "RECENTLY_TRASHED", "RECENTLY_TRASHED_ZONES", "NON_TEAM_MEMBER_SHARED_SPACE" ] }, "in": "query", "name": "action_type", "description": "Specifies the category or context of Spaces. Allowed values: ALL_SPACES, SHARED_SPACES, SHARED_BY_ME, SHARED_BY_OTHERS, PUBLISHED_WITH_TEAM, PUBLISHED_WITH_ORG, FAVOURITES, DRAFT_SPACES, RECENT_ALL_SPACES_ORG, RECENTLY_TRASHED_SPACES, RECENTLY_TRASHED, RECENTLY_TRASHED_ZONES, NON_TEAM_MEMBER_SHARED_SPACE", "required": true }, { "schema": { "x-enumDescriptions": { "RECENTLY_ACCESSED_BY_USER": "Most recently accessed by the calling user first.", "RECENTLY_OPENED": "Most recently opened first.", "TIME_CREATED": "Most recently created first.", "RECENTLY_MODIFIED_BY_USER": "Most recently modified by the calling user first.", "TIME_DELETED_DESC": "Most recently deleted first.", "TIME_DELETED_ASC": "Least recently deleted first.", "A_Z": "By name, A to Z.", "Z_A": "By name, Z to A.", "RECENTLY_TRASHED": "Most recently trashed first." }, "type": "string", "enum": [ "TIME_CREATED", "TIME_DELETED_ASC", "TIME_DELETED_DESC", "A_Z", "Z_A", "RECENTLY_OPENED", "RECENTLY_TRASHED", "RECENTLY_ACCESSED_BY_USER", "RECENTLY_MODIFIED_BY_USER" ] }, "in": "query", "name": "sort_by", "description": "Specifies the field used to sort the results. Allowed values: TIME_CREATED, TIME_DELETED_ASC, TIME_DELETED_DESC, A_Z, Z_A, RECENTLY_OPENED, RECENTLY_TRASHED, RECENTLY_ACCESSED_BY_USER, RECENTLY_MODIFIED_BY_USER", "required": true }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "filter_by", "description": "Parameter: filter_by. Max length: 100", "required": false }, { "schema": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "type": "string" }, "in": "query", "name": "search", "description": "The keyword or phrase to search for", "required": false }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "type": "boolean" }, "in": "query", "name": "need_total_count", "description": "Set this to true if you want to include the total count of items in the response. By default, this is false", "required": false }, { "$ref": "#/components/parameters/Fields6" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/state": { "put": { "summary": "Update space state", "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/UpdateSpaceStateRequest" } } } }, "operationId": "updateSpaceState", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success 2": { "value": { "data": { "edition_id": "96499735", "space_state": "RESTORE", "current_user_id": "96384499", "space_id": "3009000000093854" }, "message": "Space state updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093854/state", "status": "success" } }, "Success": { "value": { "data": { "edition_id": "96499735", "space_state": "TRASH", "current_user_id": "96384499", "space_id": "3009000000093854" }, "message": "Space state updated successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093854/state", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Space Is Not in an Active State": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "S1012", "message": "Space is not in an active state" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000093854/state", "status": "error" } }, "Space Is Not in a Trashed State": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "S1011", "message": "Space is not in an trashed state" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000141003/state", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized 2": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000000003/state", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000009003/state", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spaces" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/move": { "post": { "summary": "Move a zone to another space", "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/MoveZoneRequest" } } } }, "operationId": "moveZone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Zone Moved to a New Space": { "value": { "data": { "space_info": { "created_time": "Mon, 10 Mar 2025, 10:42:20", "last_modified_time": "Mon, 10 Mar 2025, 10:42:20", "is_favorite": "false", "space_name": "Project proposal", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "allow_embed": "false", "team_id": "693000000435005", "space_id": "693000000569361", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone moved successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/4a971774-9ea7-4f1b-94c8-7199a254d6ba/move", "status": "success" } }, "Zone Moved to a New Space with Comments": { "value": { "data": { "space_info": { "created_time": "Mon, 10 Mar 2025, 10:42:20", "last_modified_time": "Mon, 10 Mar 2025, 10:42:20", "is_favorite": "false", "space_name": "Project proposal", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "allow_embed": "false", "team_id": "693000000435005", "space_id": "693000000569361", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone moved successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/4a971774-9ea7-4f1b-94c8-7199a254d6ba/move", "status": "success" } }, "Zone Moved to an Existing Space with All Versions": { "value": { "data": { "space_info": { "created_time": "Mon, 10 Mar 2025, 10:30:38", "last_modified_time": "Mon, 10 Mar 2025, 10:32:00", "space_name": "MOVE", "publish": "false", "owner_zuid": "96384499", "team_id": "693000000435005", "allow_embed": "false", "space_id": "693000000569219", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone moved successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/b313272b-fa45-4111-b61d-de64a0044260/move", "status": "success" } }, "Zone Moved to an Existing Space": { "value": { "data": { "space_info": { "created_time": "Mon, 10 Mar 2025, 10:30:38", "last_modified_time": "Mon, 10 Mar 2025, 10:32:00", "space_name": "MOVE", "publish": "false", "owner_zuid": "96384499", "team_id": "693000000435005", "allow_embed": "false", "space_id": "693000000569219", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone moved successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/b313272b-fa45-4111-b61d-de64a0044260/move", "status": "success" } }, "Zone Moved to an Existing Space with Comments": { "value": { "data": { "space_info": { "created_time": "Mon, 10 Mar 2025, 10:30:38", "last_modified_time": "Mon, 10 Mar 2025, 10:32:00", "space_name": "MOVE", "publish": "false", "owner_zuid": "96384499", "team_id": "693000000435005", "allow_embed": "false", "space_id": "693000000569219", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone moved successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/b313272b-fa45-4111-b61d-de64a0044260/move", "status": "success" } }, "Zone Moved to a New Space with All Versions": { "value": { "data": { "space_info": { "created_time": "Mon, 10 Mar 2025, 10:42:20", "last_modified_time": "Mon, 10 Mar 2025, 10:42:20", "is_favorite": "false", "space_name": "Project proposal", "publish": "false", "owner_zuid": "96384499", "can_edit": "true", "allow_embed": "false", "team_id": "693000000435005", "space_id": "693000000569361", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone moved successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/4a971774-9ea7-4f1b-94c8-7199a254d6ba/move", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized to Move Zone to an Existing Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "693000000481013" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000481013/zones/61fae7ca-ebcc-4ab9-881c-07b1aa9c814b/move", "status": "error" } }, "Unauthorized to Move Zone to a New Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "69300000569005" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/69300000569005/zones/4a971774-9ea7-4f1b-94c8-7199a254d6ba/move", "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": { "Target Space Not Found": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "S1009", "message": "Space not found", "space_id": "69300000569005" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/69300000569005/zones/b313272b-fa45-4111-b61d-de64a0044260/move", "status": "error" } }, "Zone Not Found 2": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "Z1008", "message": "Zone not found", "space_id": "693000000569005" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000569005/zones/F2897959-A91F-4EB8-BE6B-E69411DC83F6/move", "status": "error" } }, "Zone Not Found": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "Z1008", "message": "Zone not found", "space_id": "693000000562766" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562766/zones/0c77700c-35ef-4614-aad1-b4532d8e0bd3/move", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/members": { "post": { "summary": "Share zones in a space with members", "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/ShareZonesWithMembersRequest" } } } }, "operationId": "shareZonesWithMembers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "added_members": [ { "member_id": "3009000000002003", "access_state": "PARTIAL ACCESS", "resources": [ { "member_type": "TEAM", "added_time": "Tue, 08 Jul 2025, 01:58:52", "added_by": "96384499", "resource_type": "document", "resource_id": "6800EB6E-ED24-4EA6-91C6-805445418B17", "permission": "restricted" } ] }, { "member_id": "62609972", "access_state": "PARTIAL ACCESS", "resources": [ { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:16:32", "added_by": "80215739", "resource_type": "document", "resource_id": "6800EB6E-ED24-4EA6-91C6-805445418B17", "permission": "restricted" } ] } ] }, "message": "Resource members added successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members", "status": "success" } } } } } }, "206": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Partial Success": { "value": { "data": { "failed_members": [ { "error_message": "Resource member present", "error_code": "S1042", "zuid": "3009000000002003" } ], "added_members": [ { "member_id": "85572741", "access_state": "PARTIAL ACCESS", "resources": [ { "member_type": "USER", "added_time": "Wed, 09 Jul 2025, 15:52:18", "added_by": "96384499", "resource_type": "document", "resource_id": "d7ccf816-8293-4a2f-ae83-f10c0e3a6645", "permission": "restricted" } ] } ] }, "message": "Partial success: Some resource members added, others failed.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Resource Member Present": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Resource member present", "error_code": "S1042", "zuid": "3009000000002003" }, { "error_message": "Resource member present", "error_code": "S1042", "zuid": "3009000000002003" } ], "error_code": "R1002", "message": "Resource member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members", "status": "error" } }, "Cannot Restrict The Owner": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Cannot restrict owner role", "error_code": "S1034", "zuid": "80215739" } ], "error_code": "R1002", "message": "Resource member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members", "status": "error" } }, "Cannot Restrict Non-Space Member": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Cannot restrict non-project member", "error_code": "S1041", "zuid": "300900000000203" } ], "error_code": "R1002", "message": "Resource member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members", "status": "error" } }, "Cannot Update Own Role": { "value": { "error": { "details": { "failed_members": [ { "error_message": "Cannot update own role", "error_code": "S1036", "zuid": "96384499" } ], "error_code": "R1002", "message": "Resource member add failed" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000607005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000607005/zones/members", "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": { "Space Not found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1009", "message": "Space not found", "space_id": "300900000618005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000618005/zones/members", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Conditional Sharing" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones": { "post": { "summary": "Create a new 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/CreateZoneRequest" } } } }, "operationId": "createZone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "zone_info": { "created_time": "Fri, 25 Jul 2025, 06:01:52", "zone_id": "ee01ded6-158e-4729-99b0-257ab23be6d1", "last_modified_time": "Fri, 25 Jul 2025, 06:01:52", "zone_name": "Zone 2", "space_id": "4855000000088149", "last_author_zuid": "888015717", "author_zuid": "888015717", "status": "ACTIVE" } }, "message": "Zone created successfully.", "request_uri": "/vani/api/v1/editions/888012145/spaces/4855000000088149/zones", "status": "success" } }, "Success: Zone Created Using Template": { "value": { "data": { "zone_info": { "created_time": "Fri, 25 Jul 2025, 06:02:20", "zone_id": "2bf37964-c959-4e3f-a4ac-ea09e607fb07", "last_modified_time": "Fri, 25 Jul 2025, 06:02:20", "zone_name": "Zone with template", "space_id": "4855000000088149", "last_author_zuid": "888015717", "author_zuid": "888015717", "status": "ACTIVE" } }, "message": "Zone created successfully.", "request_uri": "/vani/api/v1/editions/888012145/spaces/4855000000088149/zones", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "300900000005397" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000005397/zones", "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": { "Template Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1030", "message": "Template not found", "space_id": "3009000000419047" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000419047/zones", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Maximum Zone Limit Reached": { "value": { "error": { "details": { "edition_id": "85572652", "current_user_id": "96384499", "error_code": "Z1010", "message": "Zone creation limit reached", "space_id": "1600000000657005" } }, "request_uri": "/vani/api/v1/editions/85572652/spaces/1600000000657005/zones", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/meta": { "get": { "summary": "Get zone metadata", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZoneMeta", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "zone_info": { "created_time": "Tue, 15 Jul 2025, 10:49:13", "zone_id": "c606cdb1-ae46-47a6-847b-0a36caf9f797", "last_modified_time": "Tue, 29 Jul 2025, 13:46:46", "zone_key": "3009000000701095", "zone_name": "Zone 1", "space_id": "3009000000701079", "author_zuid": "96384499", "last_author_zuid": "96384499", "status": "ACTIVE" } }, "message": "Zone metadata fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000701079/zones/c606cdb1-ae46-47a6-847b-0a36caf9f797/meta", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Zone Inactive": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "Z1011", "message": "Zone is not in an active state", "space_id": "3009000000789069" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000789069" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta", "status": "error" } } } } } }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Restricted Zone": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1033", "message": "Restricted zone", "space_id": "3009000000789069" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000789069/zones/e42f51ec-e4dc-4dc5-9587-7a2e49dcdc2e/meta", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Zones" ] }, "put": { "summary": "Update zone metadata", "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/UpdateZoneMetaRequest" } } } }, "operationId": "updateZoneMeta", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "zone_id": "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "current_user_id": "96384499", "space_id": "1505000000022005", "new_name": "Budget Report" }, "message": "Zone name updated successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "zone_id": "a5fcca17-e9dd-414f-850d-0b920645b05d", "edition_id": "98723605", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "5265000000003011" } }, "request_uri": "/vani/api/v1/editions/98723605/spaces/5265000000003011/zones/a5fcca17-e9dd-414f-850d-0b920645b05d/meta", "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": { "Failure: Zone Not Found": { "value": { "error": { "details": { "zone_id": "198356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "current_user_id": "96384499", "error_code": "Z1008", "message": "Zone not found", "space_id": "1505000000022005" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/198356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure: New Zone Name Is Same as the Current Name": { "value": { "error": { "details": { "zone_id": "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "current_user_id": "96384499", "error_code": "Z1001", "message": "Zone name is same as the new name", "space_id": "1505000000022005" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/meta", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/templates": { "post": { "summary": "Insert a template into a zone", "security": [ { "iam-oauth2-schema": [ "Vani.zones.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.zones.CREATE" ] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertTemplateIntoZone" } } } }, "operationId": "insertTemplateIntoZone", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/state": { "put": { "summary": "Update zone state", "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/UpdateZoneStateRequest" } } } }, "operationId": "updateZoneState", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success 2": { "value": { "data": { "zone_id": "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "space_state": "TRASH", "current_user_id": "96384499", "space_id": "1505000000022005" }, "message": "Zone state updated successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/state", "status": "success" } }, "Success": { "value": { "data": { "zone_id": "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "space_state": "RESTORE", "current_user_id": "96384499", "space_id": "1505000000022005" }, "message": "Zone state updated successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/state", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Failure: Zone Threshold Violation": { "value": { "error": { "details": { "zone_id": "6F961124-4598-47D6-9BDA-1705DFBA07D7", "edition_id": "97375109", "current_user_id": "96384499", "error_code": "Z1009", "message": "Zone threshold violation", "space_id": "1505000000022005" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/6F961124-4598-47D6-9BDA-1705DFBA07D7/state", "status": "error" } }, "Failure: Zone Is Already Trashed or Deleted": { "value": { "error": { "details": { "zone_id": "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "current_user_id": "96384499", "error_code": "Z1005", "message": "Zone is already trashed or deleted", "space_id": "1505000000022005" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/state", "status": "error" } }, "Failure": { "value": { "error": { "details": { "zone_id": "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE", "edition_id": "97375109", "current_user_id": "96384499", "error_code": "Z1006", "message": "Zone is deleted or already restored", "space_id": "1505000000022005" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/598356E6-5F86-45FA-A7D5-ED8BB6D40DAE/state", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized 2": { "value": { "error": { "details": { "zone_id": "05A61516-A352-44C6-94C3-BE44F728C9D9", "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "300900000009397" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000009397/zones/05A61516-A352-44C6-94C3-BE44F728C9D9/state", "status": "error" } }, "Unauthorized": { "value": { "error": { "details": { "zone_id": "05A61516-A352-44C6-94C3-BE44F728C9D9", "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "300900000005397" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000005397/zones/05A61516-A352-44C6-94C3-BE44F728C9D9/state", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/version": { "get": { "summary": "Get the current version of a zone", "security": [ { "iam-oauth2-schema": [ "Vani.zones.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.zones.READ" ] } ], "operationId": "getZoneVersion", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "zone_versions": { "restricted_versions": [ { "modified_by": "80215739", "version_id": "1373000000529563" } ], "allowed_versions": [] } }, "message": "Zone versions fetched successfully", "request_uri": "/vani/api/v1/editions/80585907/spaces/1373000000529203/zones/1b28dc96-a3bc-45c3-9977-e4089b513a31/version", "status": "success" } }, "Using from and limit Parameters": { "value": { "data": { "zone_versions": { "restricted_versions": [], "allowed_versions": [ { "modified_by": "80215739", "version_id": "149000043835113" } ] } }, "message": "Zone versions fetched successfully", "request_uri": "/vani/api/v1/editions/75434908/spaces/149000042348078/zones/89cf903a-0701-41b3-823c-f2229436333e/version", "status": "success" } }, "Using fromDate Parameter": { "value": { "data": { "zone_versions": { "restricted_versions": [], "allowed_versions": [ { "version_time": "Fri, 24 Jan 2025, 11:55:53", "modified_by": "80215739", "description": "", "version_id": "149000043835113" } ] } }, "message": "Zone versions fetched successfully", "request_uri": "/vani/api/v1/editions/75434908/spaces/149000042348078/zones/89cf903a-0701-41b3-823c-f2229436333e/version", "status": "success" } }, "Success": { "value": { "data": { "zone_versions": { "restricted_versions": [ { "version_time": "Tue, 04 Feb 2025, 12:58:24", "modified_by": "96384499", "description": "activated", "version_id": "1600000000657036" } ], "allowed_versions": [ { "version_time": "Sun, 16 Feb 2025, 03:09:13", "modified_by": "96384499", "description": "", "version_id": "1505000000099005" }, { "version_time": "Sun, 16 Feb 2025, 03:08:50", "modified_by": "96384499", "description": "activated", "version_id": "1505000000097249" } ] } }, "message": "Zone versions fetched successfully", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/DBB83581-F98F-4120-9431-FDC16515FE00/version", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "85572652", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "160000000657005" } }, "request_uri": "/vani/api/v1/editions/85572652/spaces/160000000657005/zones/ef7b7fe1-327b-4ec1-904d-8232677d689c/version", "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": { "Zone Not Found": { "value": { "error": { "details": { "edition_id": "75434908", "current_user_id": "80215739", "error_code": "Z1008", "message": "Zone not found", "space_id": "149000042348078" } }, "request_uri": "/vani/api/v1/editions/75434908/spaces/149000042348078/zones/89cf103a-0701-41b3-823c-f2229436333e/version", "status": "error" } } } } } }, "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" }, { "schema": { "type": "string", "maxLength": 1000, "enum": [ "modified_by", "version_id", "version_time", "description", "uri" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: modified_by, version_id, version_time, description, uri", "required": false }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "type": "string" }, "in": "query", "name": "from_date", "description": "Allows you to fetch only those Zone versions that have been created or modified since the given timestamp", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Zone Versions" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/meta": { "get": { "summary": "Get metadata for all zones in a space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaceZonesMeta", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "zones_info": { "zone_order": [ "0e1e3a8a-a115-463e-bdb6-f540ab37eeb6", "6F961124-4598-47D6-9BDA-1705DFBA07D7", "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE" ], "zone_meta": { "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE": { "created_time": "Tue, 04 Feb 2025, 11:34:28", "zone_name": "Zone 3" }, "0e1e3a8a-a115-463e-bdb6-f540ab37eeb6": { "created_time": "Tue, 28 Jan 2025, 11:59:50", "zone_name": "Zone 1" }, "6F961124-4598-47D6-9BDA-1705DFBA07D7": { "created_time": "Tue, 04 Feb 2025, 11:34:26", "zone_name": "Zone 2" } } } }, "message": "Zone metadata fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000095397/zones/meta", "status": "success" } }, "Success": { "value": { "data": { "zones_info": { "zone_order": [ "0e1e3a8a-a115-463e-bdb6-f540ab37eeb6", "6F961124-4598-47D6-9BDA-1705DFBA07D7", "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE" ], "zone_meta": { "598356E6-5F86-45FA-A7D5-ED8BB6D40DAE": { "created_time": "Tue, 04 Feb 2025, 11:34:28", "last_modified_time": "Tue, 04 Feb 2025, 11:34:39", "zone_name": "Zone 3", "space_id": "1505000000022005", "author_zuid": "96384499", "last_author_zuid": "96384499", "status": "ACTIVE" }, "0e1e3a8a-a115-463e-bdb6-f540ab37eeb6": { "created_time": "Tue, 28 Jan 2025, 11:59:50", "last_modified_time": "Tue, 28 Jan 2025, 19:34:28", "zone_name": "Zone 1", "space_id": "1505000000022005", "author_zuid": "96384499", "last_author_zuid": "96384499", "status": "ACTIVE" }, "6F961124-4598-47D6-9BDA-1705DFBA07D7": { "created_time": "Tue, 04 Feb 2025, 11:34:26", "last_modified_time": "Tue, 04 Feb 2025, 11:34:35", "zone_name": "Zone 2", "space_id": "1505000000022005", "author_zuid": "96384499", "last_author_zuid": "96384499", "status": "ACTIVE" } } } }, "message": "Zone metadata fetched successfully.", "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/meta", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "97375109", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "1505000000022005" } }, "request_uri": "/vani/api/v1/editions/97375109/spaces/1505000000022005/zones/meta", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "schema": { "type": "string", "maxLength": 1000, "enum": [ "created_time", "last_modified_time", "zone_name", "author_zuid", "status", "last_author_zuid", "space_id", "state_modified_time" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: created_time, last_modified_time, zone_name, author_zuid, status, last_author_zuid, space_id, state_modified_time", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/duplicate": { "post": { "summary": "Duplicate 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/DuplicateZoneRequest" } } } }, "operationId": "duplicateZone", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "NEW SPACE - with comments": { "value": { "data": { "space_id": "693000000598369", "uri": "/vani/api/v1/editions/75918186/spaces/693000000598369/zones/meta" }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated in the Same Space with Comments": { "value": { "data": { "zone_id": "f721081a-6208-4058-95a5-fe4d787db67d", "space_id": 693000000562161 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated into a New Space": { "value": { "data": { "space_id": "693000000598369", "uri": "/vani/api/v1/editions/75918186/spaces/693000000598369/zones/meta" }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated into a New Space with Space Name": { "value": { "data": { "space_id": "693000000598439", "uri": "/vani/api/v1/editions/75918186/spaces/693000000598439/zones/meta" }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated in the Same Space with Members": { "value": { "data": { "zone_id": "f721081a-6208-4058-95a5-fe4d787db67d", "space_id": 693000000562161 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated in the Same Space with All Versions": { "value": { "data": { "zone_id": "f721081a-6208-4058-95a5-fe4d787db67d", "space_id": 693000000562161 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated in an Existing Space with All Versions": { "value": { "data": { "zone_id": "64d56703-7071-4670-8153-33819171239f", "space_id": 693000000562297 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "success" } }, "Zone Duplicated in an Existing Space": { "value": { "data": { "zone_id": "64d56703-7071-4670-8153-33819171239f", "space_id": 693000000562297 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "success" } }, "Zone Duplicated in an Existing Space with a New Zone Name": { "value": { "data": { "zone_id": "9a853213-9f1a-488d-bbcf-9efcb3e2d419", "space_id": 693000000562297 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "success" } }, "Zone Duplicated in an Existing Space Using Version ID": { "value": { "data": { "zone_id": "ea5e020b-4e3b-4e5d-8229-b38c5f8a3084", "space_id": 693000000562297 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "success" } }, "Zone Duplicated into a New Space Using Version ID": { "value": { "data": { "space_id": "693000000603451", "uri": "/vani/api/v1/editions/75918186/spaces/693000000603451/zones/meta" }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "success" } }, "Zone Duplicated in an Existing Space with Comments": { "value": { "data": { "zone_id": "64d56703-7071-4670-8153-33819171239f", "space_id": 693000000562297 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "success" } }, "Zone Duplicated in the Same Space": { "value": { "data": { "zone_id": "f721081a-6208-4058-95a5-fe4d787db67d", "space_id": 693000000562161 }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } }, "Zone Duplicated into a New Space with All Versions": { "value": { "data": { "space_id": "693000000598369", "uri": "/vani/api/v1/editions/75918186/spaces/693000000598369/zones/meta" }, "message": "Zone duplicated successfully", "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1a-4ef9-8f25-75a873ff7f10/duplicate", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized to Duplicate Zone in an Existing Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "69300000562248" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/69300000562248/zones/91c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "error" } }, "Unauthorized to Duplicate Zone in the Same Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "693000000481013" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000481013/zones/61fae7ca-ebcc-4ab9-881c-07b1aa9c814b/duplicate", "status": "error" } }, "Unauthorized to Duplicate Zone into a New Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "69300000562248" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/69300000562248/zones/91c26165-0165-4b48-b976-16c924498a8c/duplicate", "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": { "Zone Not Found in the Existing Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "Z1008", "message": "Zone not found", "space_id": "693000000562248" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562248/zones/11c26965-0165-4b48-b976-16c924498a8c/duplicate", "status": "error" } }, "Zone Not Found in the Same Space": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "Z1008", "message": "Zone not found", "space_id": "693000000562161" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000562161/zones/8915a5e7-ba1b-4ef9-8f25-75a873ff7f10/duplicate", "status": "error" } }, "Zone Not Found": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "Z1008", "message": "Zone not found", "space_id": "693000000599045" } }, "request_uri": "/vani/api/v1/editions/75918186/spaces/693000000599045/zones/2da6aa5e-8a20-4d6a-9551-e97fc4b2bd9f/duplicate", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Zones" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/zones/members/{member_id}": { "post": { "summary": "Share every zone in a space with a member", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "operationId": "shareAllZonesWithMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Shared with Team": { "value": { "data": { "space_resource_info": { "member_id": "3009000000002003", "access_state": "FULL ACCESS", "resources": [ { "member_type": "TEAM", "added_time": "Mon, 07 Jul 2025, 18:22:20", "added_by": "80215739", "resource_type": "document", "resource_id": "d7ccf816-8293-4a2f-ae83-f10c0e3a6645", "permission": "allowed" }, { "member_type": "TEAM", "added_time": "Mon, 07 Jul 2025, 18:22:20", "added_by": "80215739", "resource_type": "document", "resource_id": "31E57A34-3405-41D2-A2B6-7BAACAE9EE02", "permission": "allowed" }, { "member_type": "TEAM", "added_time": "Mon, 07 Jul 2025, 18:22:20", "added_by": "80215739", "resource_type": "document", "resource_id": "9E23791B-B3AE-4877-9119-3F636DC685AC", "permission": "allowed" }, { "member_type": "TEAM", "added_time": "Mon, 07 Jul 2025, 18:22:08", "added_by": "80215739", "resource_type": "document", "resource_id": "6800EB6E-ED24-4EA6-91C6-805445418B17", "permission": "allowed" } ], "space_id": "3009000000618005" } }, "message": "All resources shared successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002003", "status": "success" } }, "Shared with Member": { "value": { "data": { "space_resource_info": { "member_id": "62609972", "access_state": "FULL ACCESS", "resources": [ { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:13:11", "added_by": "80215739", "resource_type": "document", "resource_id": "d7ccf816-8293-4a2f-ae83-f10c0e3a6645", "permission": "allowed" }, { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:16:32", "added_by": "80215739", "resource_type": "document", "resource_id": "6800EB6E-ED24-4EA6-91C6-805445418B17", "permission": "allowed" }, { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:16:32", "added_by": "80215739", "resource_type": "document", "resource_id": "31E57A34-3405-41D2-A2B6-7BAACAE9EE02", "permission": "allowed" }, { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:13:11", "added_by": "80215739", "resource_type": "document", "resource_id": "9E23791B-B3AE-4877-9119-3F636DC685AC", "permission": "allowed" } ], "space_id": "3009000000618005" } }, "message": "All resources shared successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/62609972", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000612023" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000612023/zones/members/3009000000002004", "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": { "Member Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1015", "message": "member is not part of the Space", "space_id": "3009000000618005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002004", "status": "error" } }, "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1009", "message": "Space not found", "space_id": "300900000618005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000618005/zones/members/3009000000002004", "status": "error" } } } } } }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Member Already Has Full Access": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1045", "message": "Member already has full access", "space_id": "3009000000618005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/3009000000002003", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/MemberId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Conditional Sharing" ] }, "get": { "summary": "Get the zones in a space shared with a member", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getZonesSharedWithMember", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Get Member Resources – Full Access": { "value": { "data": { "space_resource_info": { "member_id": "96384499", "access_state": "FULL ACCESS", "resources": [], "space_id": "3009000000618005" } }, "message": "User resources fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/96384499", "status": "success" } }, "Get Member Resources – Partial Access": { "value": { "data": { "space_resource_info": { "member_id": "62609972", "access_state": "PARTIAL ACCESS", "resources": [ { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:13:11", "added_by": "80215739", "resource_type": "document", "resource_id": "9E23791B-B3AE-4877-9119-3F636DC685AC", "permission": "restricted" }, { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:13:11", "added_by": "80215739", "resource_type": "document", "resource_id": "d7ccf816-8293-4a2f-ae83-f10c0e3a6645", "permission": "allowed" }, { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:16:32", "added_by": "80215739", "resource_type": "document", "resource_id": "6800EB6E-ED24-4EA6-91C6-805445418B17", "permission": "allowed" }, { "member_type": "USER", "added_time": "Mon, 07 Jul 2025, 18:16:32", "added_by": "80215739", "resource_type": "document", "resource_id": "31E57A34-3405-41D2-A2B6-7BAACAE9EE02", "permission": "allowed" } ], "space_id": "3009000000618005" } }, "message": "User resources fetched successfully.", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/62609972", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "A1003", "message": "The user doesn't have permission to perform this action", "space_id": "3009000000612023" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000612023/zones/members/9638449", "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": { "Member Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1015", "message": "member is not part of the Space", "space_id": "3009000000618005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000618005/zones/members/9638449", "status": "error" } }, "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1009", "message": "Space not found", "space_id": "009000000618005" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/009000000618005/zones/members/62609972", "status": "error" } } } } } }, "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/MemberId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Conditional Sharing" ] } }, "/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" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/comments/search": { "get": { "summary": "Search comment text in a team", "security": [ { "iam-oauth2-schema": [ "Vani.zones.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.zones.READ" ] } ], "operationId": "searchComments", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success - No match found": { "value": { "data": { "search_result": [] }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/comments/search", "status": "success" } }, "Success": { "value": { "data": { "search_result": [ { "zone_id": "db069372-0246-42e8-a049-bdcbd84b292c", "space_name": "test duplicate project", "comment_id": "551335F3-BD3E-415A-95DC-74F241507E75", "space_id": "3009000000303003", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=db069372-0246-42e8-a049-bdcbd84b292c" } ] }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/comments/search", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Search2" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Search" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/zones/search": { "get": { "summary": "Search zone names and content in a team", "security": [ { "iam-oauth2-schema": [ "Vani.zones.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.zones.READ" ] } ], "operationId": "searchZones", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success - No match found": { "value": { "data": { "search_result": [] }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/75918186/teams/693000000002001/zones/search", "status": "success" } }, "Success": { "value": { "data": { "search_result": [ { "zone_id": "865efd0a-9b1b-418c-a894-82b63417063f", "space_name": "New Space", "zone_name": "duplicate zone with template1", "space_id": "693000000603451", "uri": "/vani/api/v1/editions/75918186/spaces/693000000603451/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=865efd0a-9b1b-418c-a894-82b63417063f" }, { "zone_id": "ea2f15ae-4e53-49f1-ad1e-e30eae16f31b", "space_name": "New Space", "zone_name": "Zone 1", "space_id": "693000000603389", "uri": "/vani/api/v1/editions/75918186/spaces/693000000603389/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=ea2f15ae-4e53-49f1-ad1e-e30eae16f31b" }, { "zone_id": "09a45216-f714-4d96-aa78-e857738060c6", "space_name": "New Space", "zone_name": "Zone 1", "space_id": "693000000603293", "uri": "/vani/api/v1/editions/75918186/spaces/693000000603293/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=09a45216-f714-4d96-aa78-e857738060c6" }, { "zone_id": "6a392f16-55ab-417d-8170-d8f1b6e17148", "space_name": "New Space test", "zone_name": "Zone 1", "space_id": "693000000603341", "uri": "/vani/api/v1/editions/75918186/spaces/693000000603341/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6a392f16-55ab-417d-8170-d8f1b6e17148" }, { "zone_id": "2da6aa5e-8a20-4d6a-955a-e97fc4b2bd9f", "space_name": "New Space test", "zone_name": "Zone 1", "space_id": "693000000599045", "uri": "/vani/api/v1/editions/75918186/spaces/693000000599045/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=2da6aa5e-8a20-4d6a-955a-e97fc4b2bd9f" }, { "zone_id": "ea5e020b-4e3b-4e5d-8229-b38c5f8a3084", "space_name": "duplicate zone b", "zone_name": "duplicate zone", "space_id": "693000000562297", "uri": "/vani/api/v1/editions/75918186/spaces/693000000562297/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=ea5e020b-4e3b-4e5d-8229-b38c5f8a3084" }, { "zone_id": "9a853213-9f1a-488d-bbcf-9efcb3e2d419", "space_name": "duplicate zone b", "zone_name": "duplicate zone", "space_id": "693000000562297", "uri": "/vani/api/v1/editions/75918186/spaces/693000000562297/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=9a853213-9f1a-488d-bbcf-9efcb3e2d419" }, { "zone_id": "64d56703-7071-4670-8153-33819171239f", "space_name": "duplicate zone b", "zone_name": "Copy of duplicate zone with template1", "space_id": "693000000562297", "uri": "/vani/api/v1/editions/75918186/spaces/693000000562297/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=64d56703-7071-4670-8153-33819171239f" }, { "zone_id": "cfcdde4d-13dc-4148-b5e4-a8adb64195a9", "space_name": "New Space", "zone_name": "duplicate zone with template1", "space_id": "693000000573098", "uri": "/vani/api/v1/editions/75918186/spaces/693000000573098/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=cfcdde4d-13dc-4148-b5e4-a8adb64195a9" }, { "zone_id": "6b6f718a-300d-4f8e-b9e8-ff53426d8874", "space_name": "MOVE", "zone_name": "Copy(2) of duplicate zone with template1", "space_id": "693000000569219", "uri": "/vani/api/v1/editions/75918186/spaces/693000000569219/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6b6f718a-300d-4f8e-b9e8-ff53426d8874" } ] }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/75918186/teams/693000000435005/zones/search", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows500R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Search2" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 500 }, "tags": [ "Search" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/frames/search": { "get": { "summary": "Search frame content in a team", "security": [ { "iam-oauth2-schema": [ "Vani.zones.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.zones.READ" ] } ], "operationId": "searchFrames", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success - No match found": { "value": { "data": { "search_result": [] }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/frames/search", "status": "success" } }, "Success": { "value": { "data": { "search_result": [ { "frame_name": "Content/Technical Writing & Brand Marketing", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "8F6541AF-A759-4FBF-9912-A3A73DEAEA33" }, { "frame_name": "Product Management", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "05752704-A388-4EDC-B089-4E0372EC4552" }, { "frame_name": "Team onboarding", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "08C5C1E6-3F2B-410F-8C2B-F5E8DA2E26AA" }, { "frame_name": "Engineering/Development", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "F361DC68-C12D-4FF0-95AF-A8CF0519C7DD" }, { "frame_name": "Design", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "2DE1E10D-EF27-4874-A9E7-15FD434AFC01" }, { "frame_name": "Product Marketing", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "EF5A9085-BA1C-4915-BF06-4BBCB37E2386" }, { "frame_name": "Pins", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "13188A26-7AC3-49D1-A763-69A4AF710071" }, { "frame_name": "Mouse Navigation", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "659A0F55-6B2B-4259-BE4A-DD49A71BB75E" }, { "frame_name": "Hyperlinks", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "F08026FB-2CAC-457F-BB63-C916EAB745B8" }, { "frame_name": "Navigating with Spacemate", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "C5270404-5149-461B-9F7C-7FD6259900EE" } ] }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/frames/search", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows500R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Search2" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 500 }, "tags": [ "Search" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/search": { "get": { "summary": "Search all content in a team", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "searchTeam", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success - No match found": { "value": { "data": { "search_result": {} }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/search", "status": "success" } }, "Success - Filter by types": { "value": { "data": { "search_result": { "comments": [ { "zone_id": "db069372-0246-42e8-a049-bdcbd84b292c", "space_name": "test duplicate project", "comment_id": "551335F3-BD3E-415A-95DC-74F241507E75", "space_id": "3009000000303003", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=db069372-0246-42e8-a049-bdcbd84b292c" } ], "zones": [ { "zone_id": "9aeb2e5c-c91e-497b-83f1-e20865b5543f", "space_name": "Vani - Getting Started", "zone_name": "Things to know", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=9aeb2e5c-c91e-497b-83f1-e20865b5543f" }, { "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4" } ] } }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/search", "status": "success" } }, "Success": { "value": { "data": { "search_result": { "comments": [ { "zone_id": "db069372-0246-42e8-a049-bdcbd84b292c", "space_name": "test duplicate project", "comment_id": "577B2B70-B190-4574-A0C0-D5DF8ACD9F0D", "space_id": "3009000000303003", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000303003/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=db069372-0246-42e8-a049-bdcbd84b292c" } ], "frames": [ { "frame_name": "Team onboarding", "zone_id": "6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "space_name": "Vani - Getting Started", "zone_name": "Who can use Vani?", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6ac7327e-19ea-441c-aeb8-7ed2689d9aa4", "frame_id": "08C5C1E6-3F2B-410F-8C2B-F5E8DA2E26AA" }, { "frame_name": "Pins", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "13188A26-7AC3-49D1-A763-69A4AF710071" }, { "frame_name": "Starting on Vani", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "A6D8C018-5CDD-4F58-ADAC-7C4D98D67E54" }, { "frame_name": "Pins", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "9D189640-16D9-4C33-A6C5-407098D9B08E" }, { "frame_name": "Uses of Vani", "zone_id": "f3dd023d-6a37-4237-9740-183c8041c2f2", "space_name": "Vani - Getting Started", "zone_name": "FAQs", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=f3dd023d-6a37-4237-9740-183c8041c2f2", "frame_id": "02A3F8FC-2F14-4EB3-BD21-2910A58920B2" }, { "frame_name": "Invite your team", "zone_id": "9aeb2e5c-c91e-497b-83f1-e20865b5543f", "space_name": "Vani - Getting Started", "zone_name": "Things to know", "space_id": "3009000000002013", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000002013/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=9aeb2e5c-c91e-497b-83f1-e20865b5543f", "frame_id": "F746EDA0-910D-465A-A494-2BD4ED80A4B5" } ], "shapes": [], "zones": [ { "zone_id": "2109e8c5-cbe7-42b7-b8e6-a900983e83cc", "space_name": "New Space", "zone_name": "Swot analysis - Research & Reference", "space_id": "3009000000100307", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000100307/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=2109e8c5-cbe7-42b7-b8e6-a900983e83cc" }, { "zone_id": "46985e9f-2d53-47a7-b3c7-2dbbfc639531", "space_name": "New Space", "zone_name": "Zone 1 - final", "space_id": "3009000000100187", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000100187/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=46985e9f-2d53-47a7-b3c7-2dbbfc639531" }, { "zone_id": "6bd164bb-8308-4446-93a0-8bf432527172", "space_name": "Team culture guide", "zone_name": "Zone 1 - final", "space_id": "3009000000095122", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000095122/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=6bd164bb-8308-4446-93a0-8bf432527172" }, { "zone_id": "cf3b11a1-df3d-42ab-b937-aab048579ff5", "space_name": "Service blueprint", "zone_name": "Service blueprint - Plan & Ship", "space_id": "3009000000093216", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000093216/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=cf3b11a1-df3d-42ab-b937-aab048579ff5" }, { "zone_id": "d58ca262-9c23-49ef-b116-96e424c7ca0d", "space_name": "PEST analysis", "zone_name": "Zone 1", "space_id": "3009000000093625", "uri": "/vani/api/v1/editions/96499735/spaces/3009000000093625/zones?action_type=GET_SPACE_DATA_WITH_ZONE_DATA&zone_id=d58ca262-9c23-49ef-b116-96e424c7ca0d" } ] } }, "message": "Content search completed successfully", "request_uri": "/vani/api/v1/editions/96499735/teams/3009000000002003/search", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows500R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Search2" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" }, { "schema": { "x-enumDescriptions": { "comments": "Search comment text.", "frames": "Search the names and contents of frames.", "shapes": "Search the text on shapes.", "zones": "Search zone names." }, "type": "string", "maxLength": 100, "enum": [ "frames", "comments", "zones", "shapes" ] }, "in": "query", "name": "types", "description": "Comma-separated list of fields to include in the response. Allowed values: frames, comments, zones, shapes", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 500 }, "tags": [ "Search" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/members/search": { "get": { "summary": "Search the members of a team", "security": [ { "iam-oauth2-schema": [ "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.teams.READ" ] } ], "operationId": "searchMembers", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success - No match found": { "value": { "data": { "next_from": 0, "search_result": [] }, "message": "Team member search completed successfully", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members/search", "status": "success" } }, "Success - Pagination": { "value": { "data": { "next_from": 1, "search_result": [ { "role_name": "MEMBER", "added_time": "Fri, 21 Aug 2026, 20:22:50", "modified_time": "Fri, 21 Aug 2026, 20:22:50", "mail_id": "user4@example.com", "added_by": "82512958", "subscriber_state": "ACTIVE", "display_name": "sakthii Admin", "zuid": "97049596" } ] }, "message": "Team member search completed successfully", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members/search", "status": "success" } }, "Success": { "value": { "data": { "next_from": 2, "search_result": [ { "role_name": "MEMBER", "modified_time": "Fri, 21 Aug 2026, 20:22:50", "added_time": "Fri, 21 Aug 2026, 20:22:50", "mail_id": "user4@example.com", "added_by": "82512958", "subscriber_state": "ACTIVE", "display_name": "sakthii Admin", "zuid": "97049596" }, { "role_name": "TEAM_ADMIN", "modified_time": "Tue, 30 Sep 2025, 12:10:11", "added_time": "Tue, 30 Sep 2025, 12:10:11", "mail_id": "user3@example.com", "added_by": "81864203", "subscriber_state": "ACTIVE", "display_name": "Sakthii5.2", "zuid": "82512958" } ] }, "message": "Team member search completed successfully", "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000002017/members/search", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "75918186", "current_user_id": "96384499", "error_code": "T1006", "team_id": "693000000002001", "message": "User is not a member of the team" } }, "request_uri": "/vani/api/v1/editions/75918186/teams/693000000002001/members/search", "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": { "Failure - Team Not Found": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "T1023", "message": "Invalid team" } }, "request_uri": "/vani/api/v1/editions/112255940/teams/5777000000009999/members/search", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows500R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "$ref": "#/components/parameters/Fields8" }, { "$ref": "#/components/parameters/Search2" }, { "$ref": "#/components/parameters/Roles" }, { "$ref": "#/components/parameters/SubscriberState" }, { "$ref": "#/components/parameters/From" }, { "$ref": "#/components/parameters/Limit" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 500 }, "tags": [ "Search" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/externalshares/status": { "get": { "summary": "Check whether external sharing is allowed for the edition and team", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ", "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ", "Vani.teams.READ" ] } ], "operationId": "getExternalShareStatus", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "external_share_edition_enabled": true }, "message": "External share status fetched successfully", "request_uri": "/vani/api/v1/editions/888012145/teams/4855000000002003/externalshares/status", "status": "success" } }, "Fetch Success": { "value": { "data": { "external_share_team_enabled": true, "external_share_edition_enabled": true, "external_share_allowed": true }, "message": "External share allowed status fetched successfully", "request_uri": "/vani/api/v1/editions/82513223/teams/1629000000002003/externalshares/status", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "schema": { "type": "string", "enum": [ "external_share_edition_enabled", "external_share_team_enabled", "external_share_allowed" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: external_share_edition_enabled, external_share_team_enabled, external_share_allowed", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "External Share" ] } }, "/vani/api/v1/editions/{edition_id}/spaces/{space_id}/externalshares": { "post": { "summary": "Publish a space as an external share", "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/ExternalShareRequest" } } } }, "operationId": "createExternalShare", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "is_password_enabled": true, "zone_ids": [ { "zone_id": "9e7a947b-470b-46e7-be64-4a617abadf43", "permission": "VIEWER" } ], "password": "1", "share_type": "PARTIAL_ZONES", "shared_time": 1752045010623, "external_share_url": "https://app.vanipublic.com/external/open/92c8c172434d1eb794100b0e52303ddaf6ec81d29608502e2b8bce9a5aab731144024ea162631784c784141d8d79c5e3e433279e6f2a4f0841ecfb01ea995155", "expiration_time": 1754627011000, "shared_by": 82512958, "permission": "VIEWER", "space_id": "1629000000297013" }, "message": "Space externally shared successfully", "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Invalid Zone ID": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "EX1006", "message": "External share zones are invalid or not available" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } }, "Invalid Expiry Time": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "EX1000", "message": "External share expiration time is invalid" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "403": { "description": "Forbidden - the caller is authenticated but not allowed to perform this operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "External Sharing Is Disabled": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "EX1003", "message": "External share is not allowed for this team" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } }, "External Sharing is Restricted For Free Plan": { "value": { "error": { "details": { "edition_id": "97054676", "current_user_id": "97049596", "error_code": "EX1004", "message": "External share is not available for edition" } }, "request_uri": "/vani/api/v1/editions/97054676/spaces/1435000000039005/externalshares", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "409": { "description": "Conflict - the requested change conflicts with the current resource state", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Already Externally Shared": { "value": { "error": { "details": { "edition_id": "112255940", "current_user_id": "82512958", "error_code": "EX1019", "message": "External share limit reached for the project.", "space_id": "5777000000929039" } }, "request_uri": "/vani/api/v1/editions/112255940/spaces/5777000000929039/externalshares", "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" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "External Share" ] }, "get": { "summary": "Get a space's external share details", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "operationId": "getSpaceExternalShares", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "shared_time": 1753678990289, "space_id": "4855000000088149" }, "message": "External share space info fetched successfully", "request_uri": "/vani/api/v1/editions/888012145/spaces/4855000000088149/externalshares", "status": "success" } }, "Success": { "value": { "data": { "is_password_enabled": true, "zone_ids": [ { "zone_id": "9e7a947b-470b-46e7-be64-4a617abadf43", "permission": "VIEWER" } ], "password": "1", "share_type": "PARTIAL_ZONES", "shared_time": 1752045307273, "external_share_url": "https://app.vanipublic.com/external/open/7b540cd851d86a3cf77b1050c19b88e02d51249cd6c08db6cf99e33e5dc14bccff15aae2435c3dc2bb534e88ab4afc2811a930ea68a6012700e7634857017d12", "expiration_time": 1754723516000, "shared_by": 82512958, "permission": "VIEWER", "space_id": "1629000000297013" }, "message": "External share space info fetched successfully", "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Not Externally Shared": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "S1046", "message": "Space is not externally shared" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } } } } } }, "401": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Unauthorized": { "value": { "error": { "details": { "edition_id": "888012145", "current_user_id": "888015717", "error_code": "EX1007", "message": "The user doesn't have permission to fetch external share info" } }, "request_uri": "/vani/api/v1/editions/888012145/spaces/485500000008849/externalshares", "status": "error" } } } } } }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows10Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/Fields5" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 10 }, "tags": [ "External Share" ] }, "delete": { "summary": "Revoke a space's external share", "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/RevokeExternalShareRequest" } } } }, "operationId": "deleteExternalShares", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Success": { "value": { "data": { "edition_id": "96499735", "current_user_id": "96384499", "space_id": "3009000000675145", "external_share_removed": true }, "message": "External share space removed successfully", "request_uri": "/vani/api/v1/editions/96499735/spaces/3009000000675145/externalshares", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "Space Is Not an External Share": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "S1046", "message": "Space is not externally shared" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "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": { "Space Not Found": { "value": { "error": { "details": { "edition_id": "96499735", "current_user_id": "96384499", "error_code": "S1009", "message": "Space not found", "space_id": "300900000675145" } }, "request_uri": "/vani/api/v1/editions/96499735/spaces/300900000675145/externalshares", "status": "error" } } } } } }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "DELETE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": true, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "External Share" ] }, "put": { "summary": "Update a space's external share", "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/ExternalShareRequest" } } } }, "operationId": "updateExternalShares", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Including Invalid zone ids": { "value": { "data": { "is_password_enabled": true, "zone_ids": [ { "zone_id": "9e7a947b-470b-46e7-be64-4a617abadf43", "permission": "COMMENTER" } ], "password": "1", "share_type": "PARTIAL_ZONES", "shared_time": 1752045307273, "external_share_url": "https://app.localvanipublic.net/external/open/ea6e71f11f7803677667dec29fc1ea2ea829c2b748a992203c8a3eea26b853568c231f96663a6b841b11c071352ee65b844d010ea52cf7e3810a7bc43c2b8c7f", "expiration_time": 1754627011000, "shared_by": 82512958, "permission": "COMMENTER", "space_id": "1629000000297013" }, "message": "External share space updated successfully", "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "success" } }, "Success": { "value": { "data": { "is_password_enabled": true, "zone_ids": [ { "zone_id": "9e7a947b-470b-46e7-be64-4a617abadf43", "permission": "COMMENTER" } ], "password": "1", "share_type": "PARTIAL_ZONES", "shared_time": 1752045307273, "external_share_url": "https://app.localvanipublic.net/external/open/e9ee62de0dd78b71ca86147cefb21346908ca9fe277f6be74969d56d23b6ee72ffb5f9a320efe03c02077df9a4d020f251823e81a63cc07b83691170a575ba8f", "expiration_time": 1754627011000, "shared_by": 82512958, "permission": "COMMENTER", "space_id": "1629000000297013" }, "message": "External share space updated successfully", "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "success" } } } } } }, "400": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" }, "examples": { "All Zone Ids Invalid": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "EX1006", "message": "External share zones are invalid or not available" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } }, "Invalid Expiry Time": { "value": { "error": { "details": { "edition_id": "82513223", "current_user_id": "82512958", "error_code": "EX1000", "message": "External share expiration time is invalid" } }, "request_uri": "/vani/api/v1/editions/82513223/spaces/1629000000297013/externalshares", "status": "error" } } } } } }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "UPDATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "External Share" ] } }, "/vani/api/v1/editions/{edition_id}/teams/{team_id}/externalshares": { "get": { "summary": "Get the external shares of a team's spaces", "security": [ { "iam-oauth2-schema": [ "Vani.editions.READ", "Vani.teams.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.editions.READ", "Vani.teams.READ" ] } ], "operationId": "getTeamExternalShares", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" }, "examples": { "Using Filter Fields": { "value": { "data": { "external_share_info": [ { "external_share_url": "https://app.vanipublic.com/external/open/418a5ec6abf2bb5b7a0486d5aaae300bcb97a2672a1086e25a81c5853896c92d27a8a01fcb9e42a82fe59e5a3c050fb2390d261c80ae2d4f33b09a56b27f58a5", "permission": "VIEWER", "space_id": "1629000000491005" }, { "external_share_url": "https://app.vanipublic.com/external/open/f42bcd0a8025fe33bd45bcb176e270275b48312abef2bf9d468a4939709cf9a68db1f73db4f8bdfee7fc07d948d360e083ee198913c863c624304fc274c8d289", "permission": "VIEWER", "space_id": "1629000000309025" }, { "external_share_url": "https://app.vanipublic.com/external/open/c7dab478035f95d89f1ad22b507b7bf98bd26c5f33c8d5123f5e85c34ae796ea09b9dd26ae6c0e6ac575a8e387eb98073530e803ecdd2cfa1ba7747726529492", "permission": "COMMENTER", "space_id": "1629000000297013" } ] }, "message": "External share spaces fetched successfully", "request_uri": "/vani/api/v1/editions/82513223/teams/1629000000002003/externalshares", "status": "success" } }, "Fetch Success": { "value": { "data": { "external_share_info": [ { "is_password_enabled": false, "zone_ids": [ { "zone_id": "F16ACD54-F0F4-4563-87E7-43EF9A7ED5F8", "permission": "VIEWER" } ], "share_type": "PARTIAL_ZONES", "shared_time": 1743162438306, "external_share_url": "https://app.vanipublic.com/external/open/418a5ec6abf2bb5b7a0486d5aaae300bcb97a2672a1086e25a81c5853896c92d27a8a01fcb9e42a82fe59e5a3c050fb2390d261c80ae2d4f33b09a56b27f58a5", "expiration_time": -1, "shared_by": 82512958, "permission": "VIEWER", "space_id": "1629000000491005" }, { "is_password_enabled": false, "zone_ids": [ { "zone_id": "4BAAB754-0244-4517-9EF8-3313B3A802EB", "permission": "VIEWER" } ], "share_type": "PARTIAL_ZONES", "shared_time": 1745419204184, "external_share_url": "https://app.vanipublic.com/external/open/f42bcd0a8025fe33bd45bcb176e270275b48312abef2bf9d468a4939709cf9a68db1f73db4f8bdfee7fc07d948d360e083ee198913c863c624304fc274c8d289", "expiration_time": -1, "shared_by": 82512958, "permission": "VIEWER", "space_id": "1629000000309025" }, { "is_password_enabled": true, "zone_ids": [ { "zone_id": "9e7a947b-470b-46e7-be64-4a617abadf43", "permission": "COMMENTER" }, { "zone_id": "33D51B0E-71A3-42FA-BF0F-9CC9BB570E63", "permission": "COMMENTER" } ], "share_type": "PARTIAL_ZONES", "shared_time": 1752045307273, "external_share_url": "https://app.vanipublic.com/external/open/c7dab478035f95d89f1ad22b507b7bf98bd26c5f33c8d5123f5e85c34ae796ea09b9dd26ae6c0e6ac575a8e387eb98073530e803ecdd2cfa1ba7747726529492", "expiration_time": 1754627011000, "shared_by": 82512958, "permission": "COMMENTER", "space_id": "1629000000297013" } ] }, "message": "External share spaces fetched successfully", "request_uri": "/vani/api/v1/editions/82513223/teams/1629000000002003/externalshares", "status": "success" } } } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/TeamId" }, { "schema": { "type": "string" }, "in": "query", "name": "from", "description": "The starting index from where the results should be fetched. Default value is 0", "required": false }, { "schema": { "pattern": "^(?:^(100|[1-9][0-9]?$))$", "type": "string" }, "in": "query", "name": "limit", "description": "The maximum number of results to return in the response. Default value is 20", "required": false }, { "$ref": "#/components/parameters/Fields5" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "External Share" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/create/flowchart": { "post": { "summary": "Create a flowchart from node and edge graph specifications", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateFlowchartRequest" } } } }, "operationId": "createFlowchart", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateFlowchartResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Structured Creation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/create/table": { "post": { "summary": "Create a new table on the board by parsing raw CSV, TSV or pipe-delimited text, with optional header row, whitespace trimming and ragged-row padding. Use for a plain layout table; use createDatabaseTable for a typed, queryable one.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateTableRequest" } } } }, "operationId": "createTable", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateTableFromDataResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Structured Creation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/create/stack": { "post": { "summary": "Create a stack structure from an ordered list of item specifications", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateStackRequest" } } } }, "operationId": "createStack", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateStackFromItemsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Structured Creation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/create/kanban": { "post": { "summary": "Create a kanban board structure from column and item specifications", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateKanbanRequest" } } } }, "operationId": "createKanban", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateKanbanFromItemsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Structured Creation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/create/mindmap": { "post": { "summary": "Create a mindmap structure from a hierarchical outline specification", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateMindmapRequest" } } } }, "operationId": "createMindmap", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateMindmapFromOutlineResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Structured Creation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/create/database-table": { "post": { "summary": "Create a typed database_table from raw tabular text data", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateDatabaseTableRequest" } } } }, "operationId": "createDatabaseTable", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "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": 30 }, "tags": [ "Structured Creation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/frames/alignment-status": { "get": { "summary": "Check whether selected frames already satisfy a requested alignment mode and optional target bounds", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getAnchoringFrameAlignmentStatus", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetFrameAlignmentStatusRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetFrameAlignmentStatusRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "anchoring_query", "description": "`anchoring_query` — JSON-encoded GetFrameAlignmentStatus request: frame_ids, mode, optional target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/frames/tidy": { "put": { "summary": "Apply tidy grid layout to selected frames using requested spacing and direction policy", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTidyFramesRequest" } } } }, "operationId": "updateAnchoringFrameTidy", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/suggest-placement/batch": { "post": { "summary": "Get ranked placement candidates for several objects in one call", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialBatchSuggestPlacementRequest" } } } }, "operationId": "querySuggestedPlacementsBatch", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchSuggestPlacementResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/objects/tidy": { "put": { "summary": "Apply tidy grid layout to selected objects using requested spacing and direction policy", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTidyObjectsRequest" } } } }, "operationId": "updateAnchoringObjectTidy", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/placement-feasibility": { "get": { "summary": "Check whether a footprint fits within a scope without overlapping", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getSpatialSearchPlacementFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetPlacementFeasibilityRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetPlacementFeasibilityRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "spatial_query", "description": "`spatial_query` — JSON-encoded GetPlacementFeasibility request: required_width, required_height, optional scope/padding/object_type/near_object. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/suggest-placement": { "get": { "summary": "Get ranked placement candidates for a new object", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getSpatialSearchSuggestPlacement", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/SuggestPlacementRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/SuggestPlacementRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "spatial_query", "description": "`spatial_query` — JSON-encoded SuggestPlacement request: required_width, required_height, optional scope/padding/object_type/near_object/max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/frames/placement-feasibility": { "get": { "summary": "Check whether a source frame can be placed relative to a target frame without violating constraints", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getAnchoringFramePlacementFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetFramePlacementFeasibilityRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetFramePlacementFeasibilityRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "anchoring_query", "description": "`anchoring_query` — JSON-encoded GetFramePlacementFeasibility request: source_frame_id, target_frame_id, relation, optional constraint. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/frames/align": { "put": { "summary": "Align selected frames using a requested alignment mode and optional target bounds", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentAlignFramesRequest" } } } }, "operationId": "updateAnchoringFrameAlign", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/objects/place": { "put": { "summary": "Move a source object relative to a target object using an anchor relation and optional placement constraints", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentPlaceObjectRelativeRequest" } } } }, "operationId": "updateAnchoringObjectPlace", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/objects/alignment-status": { "get": { "summary": "Check whether selected objects already satisfy a requested alignment mode and optional target bounds", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getAnchoringObjectAlignmentStatus", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectAlignmentStatusRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectAlignmentStatusRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "anchoring_query", "description": "`anchoring_query` — JSON-encoded GetObjectAlignmentStatus request: objects, mode, optional target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/objects/tidy-feasibility": { "get": { "summary": "Preview the tidy grid layout for selected objects without applying it", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getAnchoringObjectTidyFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/TidyObjectsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/TidyObjectsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "anchoring_query", "description": "`anchoring_query` — JSON-encoded GetObjectTidyFeasibility request: objects, optional direction/spacing/target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/empty-region/batch": { "post": { "summary": "Get ranked empty regions for several footprints in one call", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialBatchFindEmptyRegionRequest" } } } }, "operationId": "queryEmptyRegionsBatch", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchFindEmptyRegionResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/objects": { "get": { "summary": "Get the objects within a spatial scope or region", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getSpatialSearchObjects", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "spatial_query", "description": "`spatial_query` — JSON-encoded GetObjects request: optional scope, object_types, visibility flags, max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/frames/place": { "put": { "summary": "Move a source frame relative to a target frame using an anchor relation and optional placement constraints", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentPlaceFrameRelativeRequest" } } } }, "operationId": "updateAnchoringFramePlace", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/occupied-bounds/batch": { "post": { "summary": "Get union bounding boxes for several scopes in one call", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialBatchGetOccupiedBoundsRequest" } } } }, "operationId": "queryOccupiedBoundsBatch", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchGetOccupiedBoundsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/connections/reconnect": { "post": { "summary": "Move one end of an existing connection to another object", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentReconnectConnectionPayload" } } } }, "operationId": "reconnectConnection", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Connections" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/objects/align": { "put": { "summary": "Align selected objects using a requested alignment mode and optional target bounds", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentAlignObjectsRequest" } } } }, "operationId": "updateAnchoringObjectAlign", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/connections/feasibility": { "get": { "summary": "Check whether a connection between two objects is feasible", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getConnectionFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetConnectionFeasibilityRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetConnectionFeasibilityRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "connection_query", "description": "`connection_query` — JSON-encoded GetConnectionFeasibility request: source_object, target_object, optional payload (connector_type, source_side, target_side). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Connections" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/empty-region": { "get": { "summary": "Get ranked empty regions that fit a requested footprint", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getSpatialSearchEmptyRegion", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/FindEmptyRegionRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/FindEmptyRegionRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "spatial_query", "description": "`spatial_query` — JSON-encoded FindEmptyRegion request: required_width, required_height, optional scope/padding/max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/occupied-bounds": { "get": { "summary": "Get the union bounding box of all objects in a scope", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getSpatialSearchOccupiedBounds", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetOccupiedBoundsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetOccupiedBoundsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "spatial_query", "description": "`spatial_query` — JSON-encoded GetOccupiedBounds request: optional scope, object_types, visibility flags. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/clearance": { "get": { "summary": "Get the directional gap distances around an object", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getSpatialSearchClearance", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetClearanceAroundObjectRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetClearanceAroundObjectRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "spatial_query", "description": "`spatial_query` — JSON-encoded GetClearanceAroundObject request: object, optional computation scope and blocker filters. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/objects/batch": { "post": { "summary": "Run several object queries in one call", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialBatchGetObjectsRequest" } } } }, "operationId": "queryObjectsBatch", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/connections/create": { "post": { "summary": "Create a connection between two objects in a zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentCreateConnectionPayload" } } } }, "operationId": "createConnection", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Connections" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/frames/tidy-feasibility": { "get": { "summary": "Preview the tidy grid layout for selected frames without applying it", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getAnchoringFrameTidyFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/TidyFramesRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/TidyFramesRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "anchoring_query", "description": "`anchoring_query` — JSON-encoded GetFrameTidyFeasibility request: frame_ids, optional direction/spacing/target. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/anchoring/objects/placement-feasibility": { "get": { "summary": "Check whether a source object can be placed relative to a target object without violating overlap or constraint rules", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getAnchoringObjectPlacementFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectPlacementFeasibilityRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectPlacementFeasibilityRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "anchoring_query", "description": "`anchoring_query` — JSON-encoded GetObjectPlacementFeasibility request: source_object, target_object, relation, optional constraint. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Anchoring" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/spatial-search/placement-feasibility/batch": { "post": { "summary": "Check several footprints for fit in one call", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpatialBatchPlacementFeasibilityRequest" } } } }, "operationId": "queryPlacementFeasibilityBatch", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchGetPlacementFeasibilityResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/ZoneId" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Spatial Search" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/traversal/index": { "get": { "summary": "Get hierarchical index path of an object within the zone traversal order", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTraversalIndex", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetTraversalIndexResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetTraversalIndexRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetTraversalIndexRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "traversal_query", "description": "`traversal_query` — JSON-encoded GetTraversalIndex request: object, optional traversal_scope, optional payload (filter). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Traversal" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/visual-navigation/adjacent-elements": { "get": { "summary": "Get the elements adjacent to an anchor, with distance and direction", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getVisualNavigationAdjacentElements", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectsAroundRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectsAroundRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "nav_query", "description": "`nav_query` — JSON-encoded GetObjectsAround request: anchor, optional payload and scope. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Visual Navigation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/find": { "get": { "summary": "Find related objects using deterministic relation filters and optional semantic hint", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipFind", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/FindRelatedObjectsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/FindRelatedObjectsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded FindRelatedObjects request: anchor, optional scope, relation_types, relation_context, relation_query, max_depth, max_results. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/traversal/sequence": { "get": { "summary": "Get ordered traversal neighbors from an anchor point in the zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTraversalSequence", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetTraversalSequenceResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetTraversalSequenceRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetTraversalSequenceRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "traversal_query", "description": "`traversal_query` — JSON-encoded GetTraversalSequence request: anchor, optional traversal_scope, optional payload (direction, filter, max_results, wrap). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Traversal" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/traversal/window": { "get": { "summary": "Get before/after context window around an anchor object in the zone", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTraversalWindow", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetTraversalWindowResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetTraversalWindowRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetTraversalWindowRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "traversal_query", "description": "`traversal_query` — JSON-encoded GetTraversalWindow request: anchor, optional traversal_scope, optional payload (filter, before_count, after_count, wrap). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Traversal" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/descendants": { "get": { "summary": "Get hierarchical descendants of a container via BFS traversal", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipDescendants", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectDescendantsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectDescendantsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded GetObjectDescendants request: object, optional object_types, optional payload (max_depth, max_results, flat_selection | path_selection). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/ancestors": { "get": { "summary": "Get ancestor chain for an object in the zone hierarchy", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipAncestors", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectAncestorsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectAncestorsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded GetObjectAncestors request: object, optional max_levels. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/children": { "get": { "summary": "List the immediate child objects of one container (frame, group or zone root), optionally filtered by object type and windowed by range or index set. One level only - use getRelationshipDescendants for the deeper subtree.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipChildren", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectChildrenRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectChildrenRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded GetObjectChildren request: object, optional object_types, optional payload (all | range | index_set, max_results). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/visual-navigation/distance": { "get": { "summary": "Get the geometric distance between two objects", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getVisualNavigationDistance", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetDistanceBetweenObjectsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetDistanceBetweenObjectsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "nav_query", "description": "`nav_query` — JSON-encoded GetDistanceBetweenObjects request: source_object, target_object. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Visual Navigation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/connected": { "get": { "summary": "Get objects connected to anchor through connector graph traversal", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipConnected", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetConnectedObjectsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetConnectedObjectsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded GetConnectedObjects request: anchor, optional scope (container root), optional payload (direction, max_depth, max_results). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/parents": { "get": { "summary": "Get direct parent of an object in the zone hierarchy", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipParents", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetObjectParentsRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetObjectParentsRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded GetObjectParents request: object. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/relationships/evidence": { "get": { "summary": "Get deterministic relation evidence between two objects", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getRelationshipEvidence", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetRelationEvidenceRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetRelationEvidenceRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "relationship_query", "description": "`relationship_query` — JSON-encoded GetRelationEvidence request: source_object, target_object, optional relation_types and relation_context. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Relationships" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/visual-navigation/sequence": { "get": { "summary": "Get the visually ordered neighbours of an anchor object", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getVisualNavigationSequence", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetVisualSequenceRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetVisualSequenceRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "nav_query", "description": "`nav_query` — JSON-encoded GetVisualSequence request: anchor, payload (direction/filter/limits), optional scope. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Visual Navigation" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cell/paragraphtext": { "get": { "summary": "Get paragraph text for a table cell by paragraph index range", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTableCellParagraphText", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetCellParagraphTextResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetCellParagraphTextRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetCellParagraphTextRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "table_query", "description": "`table_query` — JSON-encoded GetCellParagraphText request: table, cell, payload.text.range. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/columns": { "post": { "summary": "Add a column (appended); applies its default to existing rows", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableAddColumnRequest" } } } }, "operationId": "createDatabaseTableColumn", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/columns/type/feasibility": { "get": { "summary": "Dry-run a column type change: feasibility and convertible/incompatible counts", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getDatabaseTableColumnTypeFeasibility", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "pattern": "^(?:[A-Za-z0-9-]+)$", "type": "string", "maxLength": 200 }, "in": "query", "name": "object_id", "description": "Database table object id", "required": true }, { "schema": { "pattern": "^(?:[A-Za-z0-9_-]+)$", "type": "string", "maxLength": 200 }, "in": "query", "name": "column_id", "description": "Column id to test", "required": true }, { "schema": { "pattern": "^(?:[A-Z_]+)$", "type": "string", "maxLength": 40 }, "in": "query", "name": "target_type", "description": "Target ColumnType enum name (e.g. NUMBER)", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/records/delete": { "post": { "summary": "Delete all records matching the (non-empty) filters", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableDeleteRecordsRequest" } } } }, "operationId": "deleteDatabaseTableRecords", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/records/update": { "post": { "summary": "Sparse update of an existing record's cells (set or clear)", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableUpdateRecordRequest" } } } }, "operationId": "updateDatabaseTableRecords", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/size": { "get": { "summary": "Report a table object's current dimensions as a row count and a column count. Call it first to bound row and column indexes before reading, editing, inserting or deleting.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTableSize", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetTableSizeResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetTableSizeRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetTableSizeRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "table_query", "description": "`table_query` — JSON-encoded GetTableSize request: table. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cells/merge": { "post": { "summary": "Merge a rectangular block of table cells into a single cell, given start and end row and column indexes. Reverse it with unmergeTableCells.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentMergeCellsRequest" } } } }, "operationId": "mergeTableCells", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MergeCellsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/columns/reorder": { "put": { "summary": "Reorder the table's columns to the given full order", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableReorderColumnsRequest" } } } }, "operationId": "updateDatabaseTableColumnReorder", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/rows/insert": { "post": { "summary": "Insert rows before or after an anchor row index", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentInsertRowsRequest" } } } }, "operationId": "insertTableRows", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InsertRowsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cell/paragraphcount": { "get": { "summary": "Report how many paragraphs one table cell's text contains. Use to bound a paragraph index before getTableCellParagraphText.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTableCellParagraphCount", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetCellParagraphCountResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetCellParagraphCountRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetCellParagraphCountRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "table_query", "description": "`table_query` — JSON-encoded GetCellParagraphCount request: table, cell. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cell/textlength": { "get": { "summary": "Report the character count of one table cell's text without returning the text itself. Use to bound a character range before reading or mutating that cell.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTableCellTextLength", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetCellTextLengthResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetCellTextLengthRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetCellTextLengthRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "table_query", "description": "`table_query` — JSON-encoded GetCellTextLength request: table, cell. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/columns/update": { "post": { "summary": "Apply one change to a column: rename, retype, set options, default, or constraints", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableUpdateColumnRequest" } } } }, "operationId": "updateDatabaseTableColumns", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/rows/delete": { "post": { "summary": "Remove a contiguous band of table rows given a half-open row index range (start inclusive, end exclusive). Rows below shift up, so re-read the table size before the next index-based call.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDeleteRowsRequest" } } } }, "operationId": "deleteTableRows", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteRowsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cell/edittext": { "post": { "summary": "Apply text mutation (range/cursor/all_text) to a table cell", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentEditCellTextRequest" } } } }, "operationId": "editTableCellText", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EditCellTextResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cell/text": { "get": { "summary": "Read the plain text held in one table cell, addressed by row and column index, either whole or over a character range. Returns text with formatting flattened away.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getTableCellText", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetCellTextResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "contentSchema": { "$ref": "#/components/schemas/GetCellTextRequest" }, "x-vani-schema": { "$ref": "#/components/schemas/GetCellTextRequest" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "table_query", "description": "`table_query` — JSON-encoded GetCellText request: table, cell, optional payload.text (range or all_text). Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Tables" ] }, "put": { "summary": "Overwrite one table cell's entire text with a supplied string. Whole-cell replacement - use editTableCellText for a range, cursor or otherwise partial mutation.", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.UPDATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentSetCellTextRequest" } } } }, "operationId": "updateTableCellText", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/query": { "post": { "summary": "Query database_table rows, or group and aggregate, in one call", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableQueryRecordsRequest" } } } }, "operationId": "createDatabaseTableQuery", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/columns/insert": { "post": { "summary": "Insert columns before or after an anchor column index", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentInsertColumnsRequest" } } } }, "operationId": "insertTableColumns", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/InsertColumnsResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/cells/unmerge": { "post": { "summary": "Unmerge a merged region of table cells", "x-vani-transitional": true, "description": "Pass the table reference and `payload.cell` (`{row_index, column_index}`) identifying any cell inside the merged area. The payload takes a single `cell` reference, not a `range`.", "x-vani-read-only": false, "tags": [ "Tables" ], "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/AgentUnmergeCellRequest" } } } }, "operationId": "unmergeTableCells", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UnmergeCellResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 } } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/records": { "post": { "summary": "Append a record from keyed cell assignments (partial allowed)", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableAddRecordRequest" } } } }, "operationId": "createDatabaseTableRecord", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/columns/delete": { "post": { "summary": "Delete a column (and its cells across all rows)", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDatabaseTableDeleteColumnRequest" } } } }, "operationId": "deleteDatabaseTableColumns", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse2" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/database-table/schema": { "get": { "summary": "Read database_table column schema (id, type, name, option lists) and row count", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getDatabaseTableSchema", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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" }, { "schema": { "pattern": "^(?:[A-Za-z0-9-]+)$", "type": "string", "maxLength": 200 }, "in": "query", "name": "object_id", "description": "Database table object id (mint-time UUID)", "required": true } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Database Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/table/columns/delete": { "post": { "summary": "Delete columns in a specified column index range", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentDeleteColumnsRequest" } } } }, "operationId": "deleteTableColumns", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse2" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Tables" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/text/edit": { "post": { "summary": "Canonical text mutation API for replace/insert/delete/split/merge operations", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentEditTextRequest" } } } }, "operationId": "editText", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EditTextResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Text" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/zones/{zone_id}/text/style": { "post": { "summary": "Apply portion and or paragraph style to selected text scope", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentApplyTextStyleRequest" } } } }, "operationId": "applyTextStyle", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApplyTextStyleResponse" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "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": [ "Text" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/data/list": { "get": { "summary": "List zones, frames, zone-slots or objects", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "listData", "description": "Lists data entities with optional pagination. Accepts either a single `operation` or an `operations` array for a batch request.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ListOperationDataResponseCamelCase" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows120R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/RevisionId" }, { "schema": { "contentSchema": { "type": "object", "properties": { "list_objects": { "description": "List objects in a container", "type": "object", "properties": { "container": { "description": "Container to list objects from", "type": "object", "properties": { "zone": { "description": "Zone root object list container", "type": "object", "properties": { "zone_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": "Zone root object list container", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "frame": { "description": "Frame container reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] } } }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "container" ] }, "list_frames": { "description": "List frames in a zone", "type": "object", "properties": { "zone_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": "Zone whose frames are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] }, "list_zones": { "description": "List all zones with pagination", "type": "object", "properties": { "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } } }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "list_zone_slots": { "description": "List zone object-slots", "type": "object", "properties": { "zone_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": "Zone whose object-slots are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] } } }, "x-vani-schema": { "type": "object", "properties": { "list_objects": { "description": "List objects in a container", "type": "object", "properties": { "container": { "description": "Container to list objects from", "type": "object", "properties": { "zone": { "description": "Zone root object list container", "type": "object", "properties": { "zone_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": "Zone root object list container", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "frame": { "description": "Frame container reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] } } }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "container" ] }, "list_frames": { "description": "List frames in a zone", "type": "object", "properties": { "zone_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": "Zone whose frames are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] }, "list_zones": { "description": "List all zones with pagination", "type": "object", "properties": { "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } } }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "list_zone_slots": { "description": "List zone object-slots", "type": "object", "properties": { "zone_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": "Zone whose object-slots are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] } } }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "operation", "description": "JSON-encoded single ListOperation document: {operation_id?, list_zones:{start_index?, max_results?, page_token?} | list_frames:{zone_id, start_index?, max_results?, page_token?} | list_zone_slots:{zone_id, start_index?, max_results?, page_token?} | list_objects:{container:{zone:{zone_id} | frame:{zone_id, frame_id}}, start_index?, max_results?, page_token?}}. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": false }, { "schema": { "contentSchema": { "type": "array", "items": { "type": "object", "properties": { "list_objects": { "description": "List objects in a container", "type": "object", "properties": { "container": { "description": "Container to list objects from", "type": "object", "properties": { "zone": { "description": "Zone root object list container", "type": "object", "properties": { "zone_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": "Zone root object list container", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "frame": { "description": "Frame container reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] } } }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "container" ] }, "list_frames": { "description": "List frames in a zone", "type": "object", "properties": { "zone_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": "Zone whose frames are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] }, "list_zones": { "description": "List all zones with pagination", "type": "object", "properties": { "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } } }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "list_zone_slots": { "description": "List zone object-slots", "type": "object", "properties": { "zone_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": "Zone whose object-slots are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] } } } }, "x-vani-schema": { "type": "array", "items": { "type": "object", "properties": { "list_objects": { "description": "List objects in a container", "type": "object", "properties": { "container": { "description": "Container to list objects from", "type": "object", "properties": { "zone": { "description": "Zone root object list container", "type": "object", "properties": { "zone_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": "Zone root object list container", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "frame": { "description": "Frame container reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] } } }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "container" ] }, "list_frames": { "description": "List frames in a zone", "type": "object", "properties": { "zone_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": "Zone whose frames are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] }, "list_zones": { "description": "List all zones with pagination", "type": "object", "properties": { "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } } }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "list_zone_slots": { "description": "List zone object-slots", "type": "object", "properties": { "zone_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": "Zone whose object-slots are being listed", "type": "string", "maxLength": 200 }, "start_index": { "description": "Optional inclusive start index", "type": "integer" }, "page_token": { "pattern": "^[0-9]{1,9}$", "description": "Optional opaque continuation token", "type": "string", "maxLength": 500 }, "max_results": { "description": "Optional page size", "type": "integer" } }, "required": [ "zone_id" ] } } } }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "operations", "description": "`operations` — JSON-encoded array of ListOperation documents for a batch request. Each element follows the same structure as the single operation param. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 120 }, "tags": [ "Data" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/data/update": { "post": { "summary": "Apply a single deterministic mutation operation to a Space", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataUpdateSpaceRequest" } } } }, "operationId": "updateData", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows60Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 60 }, "tags": [ "Data" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/data/get": { "get": { "summary": "Get zones, frames, objects, facets or zone-slots", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.READ" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.READ" ] } ], "x-vani-transitional": true, "operationId": "getData", "description": "Reads one or more data entities \\u2014 zone, frame, object, object facet, space or zone-slot \\u2014 through a structured operation. Accepts either a single `operation` or an `operations` array for a batch request.", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GetOperationDataResponseCamelCase" } } } ] } } } }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows120R" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "READ", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" }, { "$ref": "#/components/parameters/RevisionId" }, { "schema": { "contentSchema": { "type": "object", "properties": { "get_zone": { "description": "Get a single zone", "type": "object", "properties": { "zone_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": "Target zone id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "get_frame": { "description": "Get a single frame", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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": "Target frame id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "get_space": { "description": "Get full space metadata", "type": "object", "properties": {} }, "get_object_facet": { "description": "Get a specific object facet", "type": "object", "properties": { "facet_type": { "description": "Which facet to retrieve", "type": "string", "maxLength": 50, "enum": [ "OBJECT_FACET_TYPE_UNSPECIFIED", "OBJECT_FACET_PROPERTIES", "OBJECT_FACET_PICTURE_FILTERS", "OBJECT_FACET_TEXT_PROPERTIES" ] }, "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object", "facet_type" ] }, "get_object": { "description": "Get a full graphic object", "type": "object", "properties": { "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object" ] }, "get_zone_slot": { "description": "Get a zone object-slot", "type": "object", "properties": { "zone_slot": { "description": "Zone object-slot reference", "type": "object", "properties": { "zone_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": "Zone containing the slot", "type": "string", "maxLength": 200 }, "index": { "description": "Zero-based index in Zone.objects", "type": "integer" } }, "required": [ "zone_id" ] } }, "required": [ "zone_slot" ] } } }, "x-vani-schema": { "type": "object", "properties": { "get_zone": { "description": "Get a single zone", "type": "object", "properties": { "zone_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": "Target zone id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "get_frame": { "description": "Get a single frame", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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": "Target frame id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "get_space": { "description": "Get full space metadata", "type": "object", "properties": {} }, "get_object_facet": { "description": "Get a specific object facet", "type": "object", "properties": { "facet_type": { "description": "Which facet to retrieve", "type": "string", "maxLength": 50, "enum": [ "OBJECT_FACET_TYPE_UNSPECIFIED", "OBJECT_FACET_PROPERTIES", "OBJECT_FACET_PICTURE_FILTERS", "OBJECT_FACET_TEXT_PROPERTIES" ] }, "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object", "facet_type" ] }, "get_object": { "description": "Get a full graphic object", "type": "object", "properties": { "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object" ] }, "get_zone_slot": { "description": "Get a zone object-slot", "type": "object", "properties": { "zone_slot": { "description": "Zone object-slot reference", "type": "object", "properties": { "zone_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": "Zone containing the slot", "type": "string", "maxLength": 200 }, "index": { "description": "Zero-based index in Zone.objects", "type": "integer" } }, "required": [ "zone_id" ] } }, "required": [ "zone_slot" ] } } }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "operation", "description": "JSON-encoded single GetOperation document: {operation_id?, get_space:{} | get_zone:{zone_id} | get_frame:{zone_id, frame_id} | get_zone_slot:{zone_slot:{zone_id, index}} | get_object:{object:{zone_object:{zone_id, object_id} | frame_object:{zone_id, frame_id, object_id}}} | get_object_facet:{object:{...}, facet_type}}. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": false }, { "schema": { "contentSchema": { "type": "array", "items": { "type": "object", "properties": { "get_zone": { "description": "Get a single zone", "type": "object", "properties": { "zone_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": "Target zone id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "get_frame": { "description": "Get a single frame", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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": "Target frame id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "get_space": { "description": "Get full space metadata", "type": "object", "properties": {} }, "get_object_facet": { "description": "Get a specific object facet", "type": "object", "properties": { "facet_type": { "description": "Which facet to retrieve", "type": "string", "maxLength": 50, "enum": [ "OBJECT_FACET_TYPE_UNSPECIFIED", "OBJECT_FACET_PROPERTIES", "OBJECT_FACET_PICTURE_FILTERS", "OBJECT_FACET_TEXT_PROPERTIES" ] }, "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object", "facet_type" ] }, "get_object": { "description": "Get a full graphic object", "type": "object", "properties": { "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object" ] }, "get_zone_slot": { "description": "Get a zone object-slot", "type": "object", "properties": { "zone_slot": { "description": "Zone object-slot reference", "type": "object", "properties": { "zone_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": "Zone containing the slot", "type": "string", "maxLength": 200 }, "index": { "description": "Zero-based index in Zone.objects", "type": "integer" } }, "required": [ "zone_id" ] } }, "required": [ "zone_slot" ] } } } }, "x-vani-schema": { "type": "array", "items": { "type": "object", "properties": { "get_zone": { "description": "Get a single zone", "type": "object", "properties": { "zone_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": "Target zone id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "get_frame": { "description": "Get a single frame", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "frame_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": "Target frame id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id" ] }, "operation_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional client correlation id", "type": "string", "maxLength": 200 }, "get_space": { "description": "Get full space metadata", "type": "object", "properties": {} }, "get_object_facet": { "description": "Get a specific object facet", "type": "object", "properties": { "facet_type": { "description": "Which facet to retrieve", "type": "string", "maxLength": 50, "enum": [ "OBJECT_FACET_TYPE_UNSPECIFIED", "OBJECT_FACET_PROPERTIES", "OBJECT_FACET_PICTURE_FILTERS", "OBJECT_FACET_TEXT_PROPERTIES" ] }, "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object", "facet_type" ] }, "get_object": { "description": "Get a full graphic object", "type": "object", "properties": { "object": { "description": "Target object reference", "type": "object", "properties": { "zone_object": { "description": "Zone-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "object_id" ] }, "frame_object": { "description": "Frame-level object reference", "type": "object", "properties": { "zone_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": "Zone containing the frame", "type": "string", "maxLength": 200 }, "object_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": "VaniGraphicObject id in the frame", "type": "string", "maxLength": 200 }, "frame_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", "type": "string", "maxLength": 200 } }, "required": [ "zone_id", "frame_id", "object_id" ] } } } }, "required": [ "object" ] }, "get_zone_slot": { "description": "Get a zone object-slot", "type": "object", "properties": { "zone_slot": { "description": "Zone object-slot reference", "type": "object", "properties": { "zone_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": "Zone containing the slot", "type": "string", "maxLength": 200 }, "index": { "description": "Zero-based index in Zone.objects", "type": "integer" } }, "required": [ "zone_id" ] } }, "required": [ "zone_slot" ] } } } }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string" }, "in": "query", "name": "operations", "description": "`operations` — JSON-encoded array of GetOperation documents for a batch request. Each element follows the same structure as the single operation param. Send this value as a JSON string, not as a JSON object — URL-encode the encoded JSON.", "required": false } ], "x-vani-read-only": true, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 120 }, "tags": [ "Data" ] } }, "/sdk/v1/editions/{edition_id}/spaces/{space_id}/data/batchUpdate": { "post": { "summary": "Apply multiple deterministic mutation operations to a Space in order", "security": [ { "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] }, { "vani-api-key": [], "iam-oauth2-schema": [ "Vani.spaces.CREATE" ] } ], "x-vani-transitional": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataBatchUpdateSpaceRequest" } } } }, "operationId": "batchUpdateData", "responses": { "200": { "$ref": "#/components/responses/SuccessfulResponse" }, "400": { "$ref": "#/components/responses/InvalidRequestValidationFailed" }, "401": { "$ref": "#/components/responses/UnauthorizedMissingOrInvalidAccessToken9" }, "404": { "$ref": "#/components/responses/NotFoundAResourceNamedInThePathDoesNotEx10" }, "429": { "$ref": "#/components/responses/RateLimitExceededThisOperationAllows30Re" }, "500": { "$ref": "#/components/responses/InternalServerErrorTheRequestWasWellForm" } }, "x-vani-operation-type": "CREATE", "parameters": [ { "$ref": "#/components/parameters/EditionId" }, { "$ref": "#/components/parameters/SpaceId" } ], "x-vani-read-only": false, "x-vani-destructive": false, "x-vani-throttle": { "duration": "1M", "threshold": 30 }, "tags": [ "Data" ] } } }, "components": { "schemas": { "EditionVO": { "type": "object", "properties": { "created_time": { "type": "string" }, "last_modified_time": { "type": "string" }, "edition_id": { "type": "string" }, "edition_type_name": { "type": "string" }, "edition_role_name": { "type": "string" }, "state": { "type": "string" }, "edition_name": { "type": "string" }, "edition_owner_id": { "type": "string" }, "is_default": { "type": "string" }, "uri": { "type": "string" } } }, "CreateTeamRequest": { "type": "object", "properties": { "plan_type": { "description": "plan type. Allowed values: FREE, TRIAL, TEAM_TRIAL", "type": "string", "enum": [ "FREE", "TRIAL", "TEAM_TRIAL" ] }, "description": { "pattern": "^(?!\\s+$)(?!.*\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}\\b)(?!.*\\+?(?:\\d[\\s.-]*){5,})[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+$", "description": "description. Max length: 500", "type": "string", "maxLength": 500 }, "team_name": { "pattern": "^(?!\\s+$)(?!.*\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}\\b)(?!.*\\+?(?:\\d[\\s.-]*){5,})[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+$", "description": "team name. Max length: 100 (required)", "type": "string", "maxLength": 100 }, "from_integration": { "description": "from integration. Allowed values: MICROSOFT_TEAMS, GOOGLE_WORKSPACE, ZOHO_SHOW, ZOHO_MAIL, GOOGLE_MEET", "type": "string", "enum": [ "MICROSOFT_TEAMS", "GOOGLE_WORKSPACE", "ZOHO_SHOW", "ZOHO_MAIL", "GOOGLE_MEET" ] } }, "required": [ "team_name" ] }, "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" } } }, "EditionRequestStatusRequest": { "type": "object", "properties": { "enabled": { "description": "enabled (required)", "type": "boolean" } }, "required": [ "enabled" ] }, "DeleteTeamMemberRequest": { "type": "object", "properties": { "assign_to_zuid": { "description": "assign to zuid (required)", "type": "string" } }, "required": [ "assign_to_zuid" ] }, "UpdateTeamMemberRequest": { "type": "object", "properties": { "role": { "description": "role. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST (required)", "type": "string", "enum": [ "TEAM_ADMIN", "MEMBER", "TEAM_GUEST" ] }, "assign_to_zuid": { "description": "assign to zuid", "type": "string" } }, "required": [ "role" ] }, "UpdateTeamRequest": { "type": "object", "properties": { "description": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "description", "type": "string" }, "team_name": { "pattern": "^(?!\\s+$)(?!.*\\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}\\b)(?!.*\\+?(?:\\d[\\s.-]*){5,})[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+$", "description": "team name. Max length: 100", "type": "string", "maxLength": 100 } } }, "AcceptTeamRequestPayload": { "type": "object", "properties": { "role": { "description": "role. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST (required)", "type": "string", "enum": [ "TEAM_ADMIN", "MEMBER", "TEAM_GUEST" ] } }, "required": [ "role" ] }, "AddTeamMembersRequest": { "type": "object", "properties": { "members_info": { "minItems": 1, "maxItems": 100, "description": "members info. Max length: 11000 (required)", "type": "array", "items": { "type": "object", "properties": { "role": { "description": "role. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST (required)", "type": "string", "enum": [ "TEAM_ADMIN", "MEMBER", "TEAM_GUEST" ] }, "mail_id": { "description": "Email address of the member to add, e.g. user@example.com", "type": "string", "maxLength": 100 } }, "required": [ "mail_id", "role" ] } } }, "required": [ "members_info" ] }, "UpdateSpaceMetaRequest": { "type": "object", "properties": { "space_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "space name", "type": "string" }, "action_type": { "description": "action type. Allowed values: SPACE_NAME, FAVORITE, EMBED (required)", "type": "string", "enum": [ "SPACE_NAME", "FAVORITE", "EMBED" ] }, "value": { "description": "value", "type": "boolean" } }, "required": [ "action_type" ] }, "UpdateSpaceStateRequest": { "type": "object", "properties": { "space_state": { "description": "space state. Allowed values: RESTORE, TRASH, DELETE (required)", "type": "string", "enum": [ "RESTORE", "TRASH", "DELETE" ] } }, "required": [ "space_state" ] }, "DuplicateSpaceRequest": { "type": "object", "properties": { "duplicate_space": { "description": "duplicate space. Max length: 11000 (required)", "type": "object", "properties": { "space_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "space name", "type": "string" }, "deep_copy": { "description": "deep copy", "type": "boolean" }, "team_id": { "description": "team id", "type": "string" }, "copy_members": { "description": "copy members", "type": "boolean" }, "copy_comments": { "description": "copy comments", "type": "boolean" } } } }, "required": [ "duplicate_space" ] }, "CreateSpaceRequest": { "type": "object", "properties": { "create_space": { "description": "create space. Max length: 11000 (required)", "type": "object", "properties": { "workspace_id": { "description": "workspace id", "type": "string" }, "template_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "template name", "type": "string" }, "space_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "space name", "type": "string" }, "zone_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "zone name", "type": "string" }, "template_id": { "description": "template id", "type": "string" }, "team_id": { "description": "team id (required)", "type": "string" } }, "required": [ "team_id" ] } }, "required": [ "create_space" ] }, "UpdateSpaceMemberRequest": { "type": "object", "properties": { "role": { "description": "role. Allowed values: EDITOR, COMMENTER, VIEWER, ORGANISER (required)", "type": "string", "enum": [ "EDITOR", "COMMENTER", "VIEWER", "ORGANISER" ] } }, "required": [ "role" ] }, "AddSpaceMembersRequest": { "type": "object", "properties": { "members_info": { "minItems": 1, "maxItems": 100, "description": "members info. Max length: 11000 (required)", "type": "array", "items": { "type": "object", "properties": { "restrict_zone_ids": { "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})*)?)$", "description": "restrict zone ids. Max length: 1000", "type": "string", "maxLength": 1000 }, "role": { "description": "role. Allowed values: EDITOR, COMMENTER, VIEWER, ORGANISER (required)", "type": "string", "enum": [ "EDITOR", "COMMENTER", "VIEWER", "ORGANISER" ] }, "access_state": { "description": "access state. Allowed values: full_access, partial_access", "type": "string", "enum": [ "full_access", "partial_access" ] }, "type": { "description": "type. Allowed values: USER, TEAM, ORG (required)", "type": "string", "enum": [ "USER", "TEAM", "ORG" ] }, "zuid": { "description": "zuid. Max length: 100 (required)", "type": "string", "maxLength": 100 } }, "required": [ "zuid", "role", "type" ] } }, "requester_zuid": { "description": "requester zuid. Max length: 100", "type": "string", "maxLength": 100 } }, "required": [ "members_info" ] }, "AcceptSpaceRequestPayload": { "type": "object", "properties": { "role": { "description": "role. Allowed values: EDITOR, COMMENTER, VIEWER, ORGANISER (required)", "type": "string", "enum": [ "EDITOR", "COMMENTER", "VIEWER", "ORGANISER" ] } }, "required": [ "role" ] }, "ProjectVO": { "type": "object", "properties": { "space_members": { "type": "array", "items": {} }, "created_time": { "type": "string" }, "last_published_time": { "type": "string" }, "last_modified_time": { "type": "string" }, "is_favorite": { "type": "string" }, "can_edit": { "type": "string" }, "open_url": { "type": "string" }, "team_id": { "type": "string" }, "allow_embed": { "type": "string" }, "is_private_space": { "type": "string" }, "space_member_count": { "type": "string" }, "client_import_id": { "type": "string" }, "uri": { "type": "string" }, "file_size": { "type": "string" }, "last_saved_version": { "type": "string" }, "space_name": { "type": "string" }, "publish": { "type": "string" }, "owner_zuid": { "type": "string" }, "thumb_image_id": { "type": "string" }, "published_version_id": { "type": "string" }, "state_modified_time": { "type": "string" }, "space_id": { "type": "string" }, "last_author_zuid": { "type": "string" }, "status": { "type": "string" } } }, "DuplicateZoneRequest": { "type": "object", "properties": { "duplicate_zone": { "description": "duplicate zone. Max length: 11000 (required)", "type": "object", "properties": { "destination_type": { "description": "destination type. Allowed values: NEW_SPACE, SAME_SPACE, EXISTING_SPACE (required)", "type": "string", "enum": [ "NEW_SPACE", "SAME_SPACE", "EXISTING_SPACE" ] }, "space_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "space name", "type": "string" }, "deep_copy": { "description": "deep copy", "type": "boolean" }, "zone_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "zone name", "type": "string" }, "version_id": { "description": "version id", "type": "string" }, "team_id": { "description": "team id", "type": "string" }, "copy_members": { "description": "copy members", "type": "boolean" }, "destination_space_id": { "description": "destination space id", "type": "string" }, "copy_comments": { "description": "copy comments", "type": "boolean" } }, "required": [ "destination_type" ] } }, "required": [ "duplicate_zone" ] }, "UpdateZoneMetaRequest": { "type": "object", "properties": { "zone_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "zone name (required)", "type": "string" } }, "required": [ "zone_name" ] }, "CreateZoneRequest": { "type": "object", "properties": { "create_zone": { "description": "create zone. Max length: 11000 (required)", "type": "object", "properties": { "zone_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "zone name (required)", "type": "string" }, "template_id": { "description": "template id", "type": "string" } }, "required": [ "zone_name" ] } }, "required": [ "create_zone" ] }, "MoveZoneRequest": { "type": "object", "properties": { "move_zone": { "description": "move zone. Max length: 11000 (required)", "type": "object", "properties": { "destination_type": { "description": "destination type. Allowed values: NEW_SPACE, EXISTING_SPACE (required)", "type": "string", "enum": [ "NEW_SPACE", "EXISTING_SPACE" ] }, "space_name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "space name", "type": "string" }, "deep_copy": { "description": "deep copy", "type": "boolean" }, "team_id": { "description": "team id", "type": "string" }, "destination_space_id": { "description": "destination space id", "type": "string" }, "copy_comments": { "description": "copy comments", "type": "boolean" } }, "required": [ "destination_type" ] } }, "required": [ "move_zone" ] }, "InsertTemplateIntoZone": { "type": "object", "properties": { "template_id": { "pattern": "^[0-9]+$", "description": "Template asset global id to insert", "type": "string", "maxLength": 50 }, "placement": { "description": "Placement mode: AUTO, AT_POSITION, or NEAR_POSITION", "type": "string", "maxLength": 30, "enum": [ "AUTO", "AT_POSITION", "NEAR_POSITION" ] }, "position": { "description": "Required for AT_POSITION and NEAR_POSITION", "type": "object", "properties": { "top": { "description": "Top coordinate in zone space", "type": "number" }, "left": { "description": "Left coordinate in zone space", "type": "number" } } } }, "required": [ "template_id" ] }, "UpdateZoneStateRequest": { "type": "object", "properties": { "zone_state": { "description": "zone state. Allowed values: RESTORE, TRASH, DELETE (required)", "type": "string", "enum": [ "RESTORE", "TRASH", "DELETE" ] } }, "required": [ "zone_state" ] }, "ShareZonesWithMembersRequest": { "type": "object", "properties": { "members_info": { "minItems": 1, "maxItems": 100, "description": "members info. Max length: 11000 (required)", "type": "array", "items": { "type": "object", "properties": { "member_id": { "description": "member id. Max length: 100 (required)", "type": "string", "maxLength": 100 }, "member_type": { "description": "member type. Allowed values: USER, TEAM, ORG. Max length: 100 (required)", "type": "string", "maxLength": 100, "enum": [ "USER", "TEAM", "ORG" ] }, "role": { "description": "role. Allowed values: EDITOR, COMMENTER, VIEWER, ORGANISER", "type": "string", "enum": [ "EDITOR", "COMMENTER", "VIEWER", "ORGANISER" ] }, "resource_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": "resource id (required)", "type": "string" }, "permission": { "description": "permission. Allowed values: restricted, allowed", "type": "string", "enum": [ "restricted", "allowed" ] } }, "required": [ "member_id", "member_type", "resource_id" ] } } }, "required": [ "members_info" ] }, "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" } } }, "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" } } }, "RevokeExternalShareRequest": { "type": "object", "properties": { "external_share_id": { "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$", "description": "external share id. Max length: 500 (required)", "type": "string", "maxLength": 500 } }, "required": [ "external_share_id" ] }, "ExternalShareRequest": { "type": "object", "properties": { "is_password_enabled": { "description": "is password enabled", "type": "boolean" }, "zone_ids": { "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})*)?)$", "description": "zone ids. Max length: 1000", "type": "string", "maxLength": 1000 }, "password": { "pattern": "^(?:[a-zA-Z0-9\\-\\+\\^ '~!@#$%^&\" =?;`/|\\*()\\[\\]{}_:\\.,]+)$", "description": "password. Max length: 100", "type": "string", "maxLength": 100 }, "share_type": { "description": "share type. Allowed values: ALL_ZONES, PARTIAL_ZONES (required)", "type": "string", "enum": [ "ALL_ZONES", "PARTIAL_ZONES" ] }, "expiration_time": { "description": "expiration time. Max length: 30", "type": "string", "maxLength": 30 }, "permission": { "description": "permission. Allowed values: EDITOR, COMMENTER, VIEWER (required)", "type": "string", "enum": [ "EDITOR", "COMMENTER", "VIEWER" ] }, "link_name": { "pattern": "^(?:[a-zA-Z0-9\\-\\+\\^ '~!@#$%^&\" =?;`/|\\*()\\[\\]{}_:\\.,]+)$", "description": "link name. Max length: 255", "type": "string", "maxLength": 255 }, "external_share_id": { "pattern": "^[A-Za-z0-9_-]+\\.[A-Za-z0-9_-]+$", "description": "external share id. Max length: 500", "type": "string", "maxLength": 500 }, "status": { "description": "status. Allowed values: ACTIVE, INACTIVE", "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] } }, "required": [ "permission", "share_type" ] }, "AgentCreateMindmapRequest": { "type": "object", "properties": { "percent_bounds": { "description": "Optional preferred region as zone percentage", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "spacing": { "description": "Optional spacing configuration", "type": "object", "properties": { "manual_spacing": { "description": "Explicit spacing in canvas units (>= 0)", "type": "number" }, "auto_spacing": { "description": "Let the server compute spacing; send an empty object to enable", "type": "object", "properties": {} } } }, "top": { "description": "Top branch (single-direction layout)", "type": "object", "properties": { "children": { "minItems": 1, "maxItems": 200, "description": "Ordered child nodes for this branch direction", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } } } }, "left": { "description": "Left branch (single-direction layout)", "type": "object", "properties": { "children": { "minItems": 1, "maxItems": 200, "description": "Ordered child nodes for this branch direction", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } } } }, "bottom": { "description": "Bottom branch (single-direction layout)", "type": "object", "properties": { "children": { "minItems": 1, "maxItems": 200, "description": "Ordered child nodes for this branch direction", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } } } }, "root": { "description": "Root node content (required)", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } }, "top_down": { "description": "Top-down dual-direction layout", "type": "object", "properties": { "top": { "maxItems": 200, "description": "Ordered branch-root nodes on the top side", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } }, "bottom": { "maxItems": 200, "description": "Ordered branch-root nodes on the bottom side", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } } } }, "right": { "description": "Right branch (single-direction layout)", "type": "object", "properties": { "children": { "minItems": 1, "maxItems": 200, "description": "Ordered child nodes for this branch direction", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } } } }, "title": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional mindmap title", "type": "string", "maxLength": 1000 }, "absolute_bounds": { "description": "Optional preferred region in absolute canvas units", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "left_right": { "description": "Left-right dual-direction layout", "type": "object", "properties": { "left": { "maxItems": 200, "description": "Ordered branch-root nodes on the left side", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } }, "right": { "maxItems": 200, "description": "Ordered branch-root nodes on the right side", "type": "array", "items": { "type": "object", "properties": { "children": { "maxItems": 200, "description": "Child nodes, nested to any depth", "type": "array", "items": { "type": "object", "properties": {} } }, "content": { "description": "Content wrapper with text", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } } } }, "target": { "description": "Optional insertion target (defaults to ZONE_ROOT)", "type": "object", "properties": { "insert_index": { "description": "Insertion index within the target container", "type": "integer" }, "target_type": { "description": "Placement target type: ZONE_ROOT (default) or FRAME", "type": "string", "maxLength": 20, "enum": [ "ZONE_ROOT", "FRAME" ] }, "frame_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 (required when target_type is FRAME)", "type": "string", "maxLength": 200 } } } }, "required": [ "root" ] }, "CreateFlowchartResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/CreateFlowchartResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentCreateDatabaseTableRequest": { "type": "object", "properties": { "percent_bounds": { "description": "Optional preferred region as zone percentage", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "payload": { "description": "Database-table data specification (required)", "type": "object", "properties": { "input": { "description": "Tabular data input specification (required)", "type": "object", "properties": { "raw_text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Raw tabular text data (required)", "type": "string", "maxLength": 500000 }, "pad_missing_cells": { "description": "Pad ragged rows with empty cells to match max column count", "type": "boolean" }, "format_hint": { "default": "AUTO", "description": "Format hint for parsing (defaults to AUTO)", "type": "string", "maxLength": 10, "enum": [ "AUTO", "CSV", "TSV", "PIPE" ] }, "first_row_is_header": { "description": "Treat the first row as a header row", "type": "boolean" }, "trim_whitespace": { "description": "Trim whitespace from cell values", "type": "boolean" } }, "required": [ "raw_text" ] }, "name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "Optional database-table display name", "type": "string", "maxLength": 1000 } }, "required": [ "input" ] }, "absolute_bounds": { "description": "Optional preferred region in absolute canvas units", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "target": { "description": "Optional insertion target (defaults to ZONE_ROOT)", "type": "object", "properties": { "insert_index": { "description": "Insertion index within the target container", "type": "integer" }, "target_type": { "description": "Placement target type: ZONE_ROOT (default) or FRAME", "type": "string", "maxLength": 20, "enum": [ "ZONE_ROOT", "FRAME" ] }, "frame_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 (required when target_type is FRAME)", "type": "string", "maxLength": 200 } } } }, "required": [ "payload" ] }, "CreateFlowchartResult": { "type": "object", "properties": { "summary": { "type": "string" }, "created_objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } } } }, "CreateMindmapFromOutlineResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/CreateMindmapFromOutlineResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentError": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/AgentErrorCode" }, "message": { "type": "string" } } }, "MutationMetadata": { "type": "object", "properties": { "new_revision_id": { "type": "string" } } }, "AgentErrorCode": { "type": "string", "enum": [ "AGENT_ERROR_CODE_UNSPECIFIED", "INVALID_ARGUMENT", "SPACE_NOT_FOUND", "ZONE_NOT_FOUND", "FRAME_NOT_FOUND", "OBJECT_NOT_FOUND", "NO_EMPTY_REGION", "NO_VISUAL_NEIGHBOR", "PLACEMENT_CONFLICT", "UNSUPPORTED_OPERATION", "INTERNAL_ERROR" ] }, "CreateStackFromItemsResult": { "type": "object", "properties": { "summary": { "type": "string" }, "structure": { "$ref": "#/components/schemas/ObjectRef" } } }, "AgentCreateKanbanRequest": { "type": "object", "properties": { "percent_bounds": { "description": "Optional preferred region as zone percentage", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "spacing": { "description": "Optional spacing configuration", "type": "object", "properties": { "manual_spacing": { "description": "Explicit spacing in canvas units (>= 0)", "type": "number" }, "auto_spacing": { "description": "Let the server compute spacing; send an empty object to enable", "type": "object", "properties": {} } } }, "columns": { "minItems": 1, "maxItems": 50, "description": "Kanban column specifications (required, at least 1)", "type": "array", "items": { "type": "object", "properties": { "title": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Column title (required, non-empty)", "type": "string", "maxLength": 1000 }, "items": { "maxItems": 200, "description": "Items within this column", "type": "array", "items": { "type": "object", "properties": { "due_date_text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional user-facing due date text (not rendered yet)", "type": "string", "maxLength": 1000 }, "assignee": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional assignee/owner label (not rendered yet)", "type": "string", "maxLength": 1000 }, "priority": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional priority label (not rendered yet)", "type": "string", "maxLength": 1000 }, "content": { "description": "Visible content and lightweight semantic metadata", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } }, "status": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional status label (not rendered yet)", "type": "string", "maxLength": 1000 } } } } }, "required": [ "title" ] } }, "title": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional kanban board title", "type": "string", "maxLength": 1000 }, "absolute_bounds": { "description": "Optional preferred region in absolute canvas units", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "layout_hint": { "default": "HORIZONTAL", "description": "Board orientation (defaults to HORIZONTAL)", "type": "string", "maxLength": 20, "enum": [ "HORIZONTAL", "VERTICAL" ] }, "target": { "description": "Optional insertion target (defaults to ZONE_ROOT)", "type": "object", "properties": { "insert_index": { "description": "Insertion index within the target container", "type": "integer" }, "target_type": { "description": "Placement target type: ZONE_ROOT (default) or FRAME", "type": "string", "maxLength": 20, "enum": [ "ZONE_ROOT", "FRAME" ] }, "frame_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 (required when target_type is FRAME)", "type": "string", "maxLength": 200 } } } }, "required": [ "columns" ] }, "CreateKanbanFromItemsResult": { "type": "object", "properties": { "summary": { "type": "string" }, "structure": { "$ref": "#/components/schemas/ObjectRef" } } }, "CreateTableFromDataResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/CreateTableResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentCreateStackRequest": { "type": "object", "properties": { "percent_bounds": { "description": "Optional preferred region as zone percentage", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "spacing": { "description": "Optional spacing configuration", "type": "object", "properties": { "manual_spacing": { "description": "Explicit spacing in canvas units (>= 0)", "type": "number" }, "auto_spacing": { "description": "Let the server compute spacing; send an empty object to enable", "type": "object", "properties": {} } } }, "title": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional stack title", "type": "string", "maxLength": 1000 }, "absolute_bounds": { "description": "Optional preferred region in absolute canvas units", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "items": { "minItems": 1, "maxItems": 200, "description": "Ordered item specifications (required, at least 1)", "type": "array", "items": { "type": "object", "properties": { "content": { "description": "Visible content and lightweight semantic metadata", "type": "object", "properties": { "notes": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional longer supporting text", "type": "string", "maxLength": 10000 }, "link_url": { "pattern": "^https?://[^\\s<>\"]{1,2000}$", "description": "Optional external link associated with the created object", "type": "string", "maxLength": 2000 }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Primary visible label/content", "type": "string", "maxLength": 5000 }, "tags": { "maxItems": 50, "description": "Optional semantic tags/labels", "type": "array", "items": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "type": "string", "maxLength": 200 } } } } } } }, "layout_hint": { "default": "STACK_VERTICAL", "description": "Stack orientation (defaults to STACK_VERTICAL)", "type": "string", "maxLength": 30, "enum": [ "STACK_VERTICAL", "STACK_HORIZONTAL" ] }, "target": { "description": "Optional insertion target (defaults to ZONE_ROOT)", "type": "object", "properties": { "insert_index": { "description": "Insertion index within the target container", "type": "integer" }, "target_type": { "description": "Placement target type: ZONE_ROOT (default) or FRAME", "type": "string", "maxLength": 20, "enum": [ "ZONE_ROOT", "FRAME" ] }, "frame_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 (required when target_type is FRAME)", "type": "string", "maxLength": 200 } } } }, "required": [ "items" ] }, "CreateKanbanFromItemsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/CreateKanbanFromItemsResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "CreateStackFromItemsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/CreateStackFromItemsResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "CreateMindmapFromOutlineResult": { "type": "object", "properties": { "summary": { "type": "string" }, "structure": { "$ref": "#/components/schemas/ObjectRef" } } }, "AgentCreateFlowchartRequest": { "type": "object", "properties": { "percent_bounds": { "description": "Optional preferred region as zone percentage", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "payload": { "description": "Flowchart graph specification (required)", "type": "object", "properties": { "nodes": { "minItems": 1, "maxItems": 50, "description": "Flowchart node specifications (required, 1-50)", "type": "array", "items": { "type": "object", "properties": { "preferred_shape": { "default": "PROCESS", "description": "Flowchart shape type (defaults to PROCESS)", "type": "string", "maxLength": 50, "enum": [ "PROCESS", "DECISION", "TERMINATOR", "DATA", "DOCUMENT", "PREDEFINED_PROCESS", "INTERNAL_STORAGE", "ALTERNATE_PROCESS", "MULTI_DOCUMENT", "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" ] }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Display text for the node (required, non-empty)", "type": "string", "maxLength": 5000 }, "node_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Unique node identifier within this flowchart (required, non-empty)", "type": "string", "maxLength": 200 } }, "required": [ "node_id", "text" ] } }, "edges": { "maxItems": 100, "description": "Flowchart edge specifications (optional, max 100)", "type": "array", "items": { "type": "object", "properties": { "from_node_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Source node id (required)", "type": "string", "maxLength": 200 }, "start_marker": { "description": "Marker at the source end (defaults to server default)", "type": "string", "maxLength": 20, "enum": [ "NONE", "OPEN", "BLOCK", "CLASSIC", "DIAMOND", "OVAL" ] }, "connector_type": { "default": "ELBOW", "description": "Connector routing type (defaults to ELBOW)", "type": "string", "maxLength": 20, "enum": [ "LINE", "ELBOW", "CURVE" ] }, "label": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional text label on the connector", "type": "string", "maxLength": 2000 }, "end_marker": { "description": "Marker at the target end (defaults to server default)", "type": "string", "maxLength": 20, "enum": [ "NONE", "OPEN", "BLOCK", "CLASSIC", "DIAMOND", "OVAL" ] }, "to_node_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Target node id (required)", "type": "string", "maxLength": 200 } }, "required": [ "from_node_id", "to_node_id" ] } }, "layout_direction": { "default": "TOP_DOWN", "description": "Layout direction (defaults to TOP_DOWN)", "type": "string", "maxLength": 20, "enum": [ "TOP_DOWN", "LEFT_RIGHT" ] }, "title": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional flowchart title", "type": "string", "maxLength": 1000 } }, "required": [ "nodes" ] }, "absolute_bounds": { "description": "Optional preferred region in absolute canvas units", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "target": { "description": "Optional insertion target (defaults to ZONE_ROOT)", "type": "object", "properties": { "insert_index": { "description": "Insertion index within the target container", "type": "integer" }, "target_type": { "description": "Placement target type: ZONE_ROOT (default) or FRAME", "type": "string", "maxLength": 20, "enum": [ "ZONE_ROOT", "FRAME" ] }, "frame_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 (required when target_type is FRAME)", "type": "string", "maxLength": 200 } } } }, "required": [ "payload" ] }, "CreateTableResult": { "type": "object", "properties": { "summary": { "type": "string" }, "used_header_row": { "type": "boolean" }, "table": { "$ref": "#/components/schemas/ObjectRef" } } }, "AgentCreateTableRequest": { "type": "object", "properties": { "percent_bounds": { "description": "Optional preferred region as zone percentage", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "payload": { "description": "Table data specification (required)", "type": "object", "properties": { "input": { "description": "Tabular data input specification (required)", "type": "object", "properties": { "raw_text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Raw tabular text data (required)", "type": "string", "maxLength": 500000 }, "pad_missing_cells": { "description": "Pad ragged rows with empty cells to match max column count", "type": "boolean" }, "format_hint": { "default": "AUTO", "description": "Format hint for parsing (defaults to AUTO)", "type": "string", "maxLength": 10, "enum": [ "AUTO", "CSV", "TSV", "PIPE" ] }, "first_row_is_header": { "description": "Treat the first row as a header row", "type": "boolean" }, "trim_whitespace": { "description": "Trim whitespace from cell values", "type": "boolean" } }, "required": [ "raw_text" ] }, "title": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Optional table title", "type": "string", "maxLength": 1000 } }, "required": [ "input" ] }, "absolute_bounds": { "description": "Optional preferred region in absolute canvas units", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "target": { "description": "Optional insertion target (defaults to ZONE_ROOT)", "type": "object", "properties": { "insert_index": { "description": "Insertion index within the target container", "type": "integer" }, "target_type": { "description": "Placement target type: ZONE_ROOT (default) or FRAME", "type": "string", "maxLength": 20, "enum": [ "ZONE_ROOT", "FRAME" ] }, "frame_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 (required when target_type is FRAME)", "type": "string", "maxLength": 200 } } } }, "required": [ "payload" ] }, "SpatialBatchGetOccupiedBoundsRequest": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 50, "description": "requests. Max length: 2000000 (required)", "type": "array", "items": { "type": "object", "properties": { "object_types": { "maxItems": 20, "description": "Object-type filter; empty means all types", "type": "array", "items": { "type": "string", "maxLength": 60, "enum": [ "VANI_OBJECT_TYPE_UNSPECIFIED", "VANI_OBJECT_TYPE_SHAPE", "VANI_OBJECT_TYPE_CONNECTOR", "VANI_OBJECT_TYPE_PICTURE", "VANI_OBJECT_TYPE_GROUP_SHAPE", "VANI_OBJECT_TYPE_DOMAIN_DIAGRAM", "VANI_OBJECT_TYPE_DIAGRAM", "VANI_OBJECT_TYPE_STRUCTURE", "VANI_OBJECT_TYPE_STRUCTURE_MINDMAP", "VANI_OBJECT_TYPE_STRUCTURE_KANBAN", "VANI_OBJECT_TYPE_STRUCTURE_STACK", "VANI_OBJECT_TYPE_TABLE", "VANI_OBJECT_TYPE_CHART", "VANI_OBJECT_TYPE_DATABASE_TABLE", "VANI_OBJECT_TYPE_STICKY_NOTE" ] } }, "include_hidden": { "description": "Include hidden objects when true", "type": "boolean" }, "scope": { "description": "Optional scope selector; defaults to SCOPE_TYPE_ZONE", "type": "object", "properties": { "percent_bounds": { "description": "Region refinement: bounds normalized to the selected container. Oneof with absolute_bounds", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "absolute_bounds": { "description": "Region refinement: absolute bounds in zone coordinates. Oneof with percent_bounds", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "scope_type": { "default": "SCOPE_TYPE_ZONE", "description": "Scope type selector; defaults to SCOPE_TYPE_ZONE", "type": "string", "maxLength": 50, "enum": [ "SCOPE_TYPE_UNSPECIFIED", "SCOPE_TYPE_ZONE", "SCOPE_TYPE_FRAME" ] }, "frame_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 when scope_type is SCOPE_TYPE_FRAME", "type": "string", "maxLength": 200 } } }, "include_locked": { "description": "Include locked objects when true", "type": "boolean" } } } }, "request_item_ids": { "maxItems": 50, "description": "Optional correlation IDs echoed back in response", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } }, "required": [ "requests" ] }, "AgentCreateConnectionPayload": { "type": "object", "properties": { "payload": { "description": "Shared connector options payload (connector_type, source_side, target_side)", "type": "object", "properties": { "connector_type": { "default": "LINE", "description": "Preferred connector type; defaults to LINE", "type": "string", "maxLength": 10, "enum": [ "LINE", "ELBOW", "CURVE" ] }, "target_side": { "description": "Preferred target endpoint side; UNKNOWN_SIDE lets server auto-resolve", "type": "string", "maxLength": 20, "enum": [ "UNKNOWN_SIDE", "NORTH", "EAST", "SOUTH", "WEST" ] }, "source_side": { "description": "Preferred source endpoint side; UNKNOWN_SIDE lets server auto-resolve", "type": "string", "maxLength": 20, "enum": [ "UNKNOWN_SIDE", "NORTH", "EAST", "SOUTH", "WEST" ] } } }, "target_object": { "description": "Target endpoint object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "context": { "description": "Request context with zone scope", "type": "object", "properties": { "zone_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": "Target zone id (required)", "type": "string", "maxLength": 200 }, "validate_only": { "description": "Validate/dry-run mode when true", "type": "boolean" }, "actor_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}$|^[0-9]+$)$", "description": "Calling actor/agent id", "type": "string", "maxLength": 200 }, "base_revision_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional optimistic-concurrency token for mutating operations", "type": "string", "maxLength": 200 }, "request_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Client-supplied request correlation id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] }, "source_object": { "description": "Source endpoint object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } } }, "required": [ "context", "source_object", "target_object" ] }, "Connector_ConnectorType": { "type": "string", "enum": [ "LINE", "ELBOW", "CURVE" ] }, "AgentAlignObjectsRequest": { "type": "object", "properties": { "mode": { "description": "Alignment or distribution mode", "type": "string", "maxLength": 50, "enum": [ "ALIGN_MODE_UNSPECIFIED", "ALIGN_LEFT_EDGE", "ALIGN_RIGHT_EDGE", "ALIGN_TOP_EDGE", "ALIGN_BOTTOM_EDGE", "ALIGN_HORIZONTAL_CENTER", "ALIGN_VERTICAL_CENTER", "DISTRIBUTE_HORIZONTAL", "DISTRIBUTE_VERTICAL" ] }, "objects": { "minItems": 2, "maxItems": 500, "description": "Objects to align or distribute (minimum 2)", "type": "array", "items": { "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } } }, "target": { "description": "Optional alignment target; defaults to WITHIN_SELECTION", "type": "object", "properties": { "reference": { "default": "WITHIN_SELECTION", "description": "Alignment reference; defaults to WITHIN_SELECTION", "type": "string", "maxLength": 50, "enum": [ "OBJECT_ALIGN_REFERENCE_UNSPECIFIED", "WITHIN_SELECTION", "CURRENT_FRAME", "TARGET_BOUNDS" ] }, "target_bounds": { "description": "Explicit bounds, used when reference is TARGET_BOUNDS", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } } } } }, "required": [ "objects", "mode" ] }, "AnchoringConstraint_CrossAxisAlignment": { "type": "string", "enum": [ "CROSS_AXIS_ALIGNMENT_UNSPECIFIED", "START", "CENTER", "END" ] }, "AgentPlaceFrameRelativeRequest": { "type": "object", "properties": { "target_frame_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": "Reference target frame", "type": "string", "maxLength": 200 }, "constraint": { "description": "Optional placement constraints", "type": "object", "properties": { "keep_inside_container": { "description": "Clamp final bounds within the primary container", "type": "boolean" }, "avoid_overlap": { "description": "Reject or adjust placements that collide with other objects", "type": "boolean" }, "cross_axis_alignment": { "default": "CENTER", "description": "Cross-axis alignment; defaults to CENTER", "type": "string", "maxLength": 40, "enum": [ "CROSS_AXIS_ALIGNMENT_UNSPECIFIED", "START", "CENTER", "END" ] }, "gap": { "description": "Requested edge-to-edge spacing between source and target (>= 0)", "type": "number" }, "snap_to_grid": { "description": "Snap the final position to layout guides/grid", "type": "boolean" } } }, "source_frame_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 to move", "type": "string", "maxLength": 200 }, "relation": { "description": "Desired relation from source frame to target frame", "type": "string", "maxLength": 60, "enum": [ "ANCHOR_RELATION_UNSPECIFIED", "ANCHOR_RELATION_LEFT", "ANCHOR_RELATION_RIGHT", "ANCHOR_RELATION_TOP", "ANCHOR_RELATION_BOTTOM" ] } }, "required": [ "source_frame_id", "target_frame_id", "relation" ] }, "TidyFramesRequest": { "type": "object", "properties": { "fixed_spacing": { "format": "float", "type": "string" }, "frame_ids": { "type": "array", "items": { "type": "string" } }, "direction": { "$ref": "#/components/schemas/TidyDirection" }, "spacing_mode": { "$ref": "#/components/schemas/TidySpacingMode" }, "preserve_order": { "type": "boolean" }, "target": { "$ref": "#/components/schemas/FrameAlignTarget" } } }, "GetOccupiedBoundsRequest": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "include_hidden": { "type": "boolean" }, "scope": { "$ref": "#/components/schemas/SpatialScope" }, "include_locked": { "type": "boolean" } } }, "GetFramePlacementFeasibilityRequest": { "type": "object", "properties": { "target_frame_id": { "type": "string" }, "constraint": { "$ref": "#/components/schemas/AnchoringConstraint" }, "source_frame_id": { "type": "string" }, "relation": { "$ref": "#/components/schemas/AnchorRelation" } } }, "ContainerScope_ScopeType": { "type": "string", "enum": [ "SCOPE_TYPE_UNSPECIFIED", "ZONE_ROOT", "FRAME_ROOT", "GROUP_ROOT" ] }, "FindEmptyRegionRequest": { "type": "object", "properties": { "padding": { "format": "float", "type": "string" }, "scope": { "$ref": "#/components/schemas/SpatialScope" }, "required_width": { "format": "float", "type": "string" }, "max_results": { "format": "int32", "type": "string" }, "required_height": { "format": "float", "type": "string" } } }, "GetObjectAlignmentStatusRequest": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/AlignMode" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "target": { "$ref": "#/components/schemas/ObjectAlignTarget" } } }, "Bounds": { "type": "object", "properties": { "x": { "format": "float", "type": "string" }, "width": { "format": "float", "type": "string" }, "y": { "format": "float", "type": "string" }, "height": { "format": "float", "type": "string" } } }, "FrameAlignTarget_AlignReference": { "type": "string", "enum": [ "FRAME_ALIGN_REFERENCE_UNSPECIFIED", "WITHIN_SELECTION", "TARGET_BOUNDS" ] }, "AnchorRelation": { "type": "string", "enum": [ "ANCHOR_RELATION_UNSPECIFIED", "ANCHOR_RELATION_LEFT", "ANCHOR_RELATION_RIGHT", "ANCHOR_RELATION_TOP", "ANCHOR_RELATION_BOTTOM" ] }, "CandidateRegion": { "type": "object", "properties": { "score": { "format": "float", "type": "string" }, "bounds": { "$ref": "#/components/schemas/Bounds" }, "rationale": { "type": "string" } } }, "ObjectAlignTarget_AlignReference": { "type": "string", "enum": [ "OBJECT_ALIGN_REFERENCE_UNSPECIFIED", "WITHIN_SELECTION", "CURRENT_FRAME", "TARGET_BOUNDS" ] }, "GetPlacementFeasibilityResult": { "type": "object", "properties": { "reason": { "type": "string" }, "suggested_alternative": { "$ref": "#/components/schemas/CandidateRegion" }, "feasible": { "type": "boolean" } } }, "GetObjectPlacementFeasibilityRequest": { "type": "object", "properties": { "target_object": { "$ref": "#/components/schemas/ObjectRef" }, "source_object": { "$ref": "#/components/schemas/ObjectRef" }, "constraint": { "$ref": "#/components/schemas/AnchoringConstraint" }, "relation": { "$ref": "#/components/schemas/AnchorRelation" } } }, "BatchSuggestPlacementResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/SuggestPlacementResponse" } }, "error": { "$ref": "#/components/schemas/AgentError" }, "request_item_ids": { "type": "array", "items": { "type": "string" } } } }, "Connector_ConnectionSide": { "type": "string", "enum": [ "UNKNOWN_SIDE", "NORTH", "EAST", "SOUTH", "WEST" ] }, "BatchFindEmptyRegionResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/FindEmptyRegionResponse" } }, "error": { "$ref": "#/components/schemas/AgentError" }, "request_item_ids": { "type": "array", "items": { "type": "string" } } } }, "AgentTidyFramesRequest": { "type": "object", "properties": { "fixed_spacing": { "description": "Gap used when spacing_mode is TIDY_SPACING_MODE_FIXED", "type": "number" }, "frame_ids": { "minItems": 2, "maxItems": 500, "description": "Frames to tidy (minimum 2)", "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": 200 } }, "direction": { "description": "Tidy direction policy", "type": "string", "maxLength": 50, "enum": [ "TIDY_DIRECTION_UNSPECIFIED", "TIDY_DIRECTION_AUTO", "TIDY_DIRECTION_HORIZONTAL", "TIDY_DIRECTION_VERTICAL" ] }, "spacing_mode": { "description": "Spacing policy", "type": "string", "maxLength": 50, "enum": [ "TIDY_SPACING_MODE_UNSPECIFIED", "TIDY_SPACING_MODE_AUTO", "TIDY_SPACING_MODE_FIXED" ] }, "preserve_order": { "description": "Preserve current traversal order while tidying", "type": "boolean" }, "target": { "description": "Optional tidy target; defaults to WITHIN_SELECTION", "type": "object", "properties": { "reference": { "default": "WITHIN_SELECTION", "description": "Alignment reference; defaults to WITHIN_SELECTION", "type": "string", "maxLength": 50, "enum": [ "FRAME_ALIGN_REFERENCE_UNSPECIFIED", "WITHIN_SELECTION", "TARGET_BOUNDS" ] }, "target_bounds": { "description": "Explicit bounds, used when reference is TARGET_BOUNDS", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } } } } }, "required": [ "frame_ids" ] }, "SpatialBatchPlacementFeasibilityRequest": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 50, "description": "requests. Max length: 2000000 (required)", "type": "array", "items": { "type": "object", "properties": { "padding": { "description": "Required clearance from nearby objects and bounds", "type": "number" }, "object_type": { "description": "Type of object to be placed", "type": "string", "maxLength": 60, "enum": [ "VANI_OBJECT_TYPE_UNSPECIFIED", "VANI_OBJECT_TYPE_SHAPE", "VANI_OBJECT_TYPE_CONNECTOR", "VANI_OBJECT_TYPE_PICTURE", "VANI_OBJECT_TYPE_GROUP_SHAPE", "VANI_OBJECT_TYPE_DOMAIN_DIAGRAM", "VANI_OBJECT_TYPE_DIAGRAM", "VANI_OBJECT_TYPE_STRUCTURE", "VANI_OBJECT_TYPE_STRUCTURE_MINDMAP", "VANI_OBJECT_TYPE_STRUCTURE_KANBAN", "VANI_OBJECT_TYPE_STRUCTURE_STACK", "VANI_OBJECT_TYPE_TABLE", "VANI_OBJECT_TYPE_CHART", "VANI_OBJECT_TYPE_DATABASE_TABLE", "VANI_OBJECT_TYPE_STICKY_NOTE" ] }, "near_object": { "description": "Optional anchor object for relation-aware validation", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "scope": { "description": "Optional scope selector; defaults to SCOPE_TYPE_ZONE", "type": "object", "properties": { "percent_bounds": { "description": "Region refinement: bounds normalized to the selected container. Oneof with absolute_bounds", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "absolute_bounds": { "description": "Region refinement: absolute bounds in zone coordinates. Oneof with percent_bounds", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "scope_type": { "default": "SCOPE_TYPE_ZONE", "description": "Scope type selector; defaults to SCOPE_TYPE_ZONE", "type": "string", "maxLength": 50, "enum": [ "SCOPE_TYPE_UNSPECIFIED", "SCOPE_TYPE_ZONE", "SCOPE_TYPE_FRAME" ] }, "frame_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 when scope_type is SCOPE_TYPE_FRAME", "type": "string", "maxLength": 200 } } }, "required_width": { "description": "Footprint width to validate", "type": "number" }, "required_height": { "description": "Footprint height to validate", "type": "number" } }, "required": [ "required_width", "required_height" ] } }, "request_item_ids": { "maxItems": 50, "description": "Optional correlation IDs echoed back in response", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } }, "required": [ "requests" ] }, "SuggestPlacementRequest": { "type": "object", "properties": { "padding": { "format": "float", "type": "string" }, "object_type": { "$ref": "#/components/schemas/VaniObjectType" }, "near_object": { "$ref": "#/components/schemas/ObjectRef" }, "scope": { "$ref": "#/components/schemas/SpatialScope" }, "required_width": { "format": "float", "type": "string" }, "max_results": { "format": "int32", "type": "string" }, "required_height": { "format": "float", "type": "string" } } }, "GetOccupiedBoundsResponse": { "type": "object", "properties": { "occupied_bounds": { "$ref": "#/components/schemas/Bounds" }, "object_count": { "format": "int32", "type": "string" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentTidyObjectsRequest": { "type": "object", "properties": { "fixed_spacing": { "description": "Gap used when spacing_mode is TIDY_SPACING_MODE_FIXED", "type": "number" }, "objects": { "minItems": 2, "maxItems": 500, "description": "Objects to tidy (minimum 2)", "type": "array", "items": { "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } } }, "direction": { "description": "Tidy direction policy", "type": "string", "maxLength": 50, "enum": [ "TIDY_DIRECTION_UNSPECIFIED", "TIDY_DIRECTION_AUTO", "TIDY_DIRECTION_HORIZONTAL", "TIDY_DIRECTION_VERTICAL" ] }, "spacing_mode": { "description": "Spacing policy", "type": "string", "maxLength": 50, "enum": [ "TIDY_SPACING_MODE_UNSPECIFIED", "TIDY_SPACING_MODE_AUTO", "TIDY_SPACING_MODE_FIXED" ] }, "preserve_order": { "description": "Preserve current traversal order while tidying", "type": "boolean" }, "target": { "description": "Optional tidy target; defaults to WITHIN_SELECTION", "type": "object", "properties": { "reference": { "default": "WITHIN_SELECTION", "description": "Alignment reference; defaults to WITHIN_SELECTION", "type": "string", "maxLength": 50, "enum": [ "OBJECT_ALIGN_REFERENCE_UNSPECIFIED", "WITHIN_SELECTION", "CURRENT_FRAME", "TARGET_BOUNDS" ] }, "target_bounds": { "description": "Explicit bounds, used when reference is TARGET_BOUNDS", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } } } } }, "required": [ "objects" ] }, "SpatialScope_ScopeType": { "type": "string", "enum": [ "SCOPE_TYPE_UNSPECIFIED", "SCOPE_TYPE_ZONE", "SCOPE_TYPE_FRAME" ] }, "FindEmptyRegionResponse": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateRegion" } }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "GetObjectsRequest": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "include_hidden": { "type": "boolean" }, "scope": { "$ref": "#/components/schemas/SpatialScope" }, "max_results": { "format": "int32", "type": "string" }, "include_locked": { "type": "boolean" } } }, "SpatialComputationScope": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "container_scope", "absolute_bounds", "percent_bounds" ], "name": "mode" } ], "properties": { "percent_bounds": { "$ref": "#/components/schemas/PercentBounds" }, "container_scope": { "$ref": "#/components/schemas/ContainerScope" }, "absolute_bounds": { "$ref": "#/components/schemas/Bounds" } } }, "SpatialBatchFindEmptyRegionRequest": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 50, "description": "requests. Max length: 2000000 (required)", "type": "array", "items": { "type": "object", "properties": { "padding": { "description": "Additional clearance after footprint fit is checked", "type": "number" }, "scope": { "description": "Optional scope selector; defaults to SCOPE_TYPE_ZONE", "type": "object", "properties": { "percent_bounds": { "description": "Region refinement: bounds normalized to the selected container. Oneof with absolute_bounds", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "absolute_bounds": { "description": "Region refinement: absolute bounds in zone coordinates. Oneof with percent_bounds", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "scope_type": { "default": "SCOPE_TYPE_ZONE", "description": "Scope type selector; defaults to SCOPE_TYPE_ZONE", "type": "string", "maxLength": 50, "enum": [ "SCOPE_TYPE_UNSPECIFIED", "SCOPE_TYPE_ZONE", "SCOPE_TYPE_FRAME" ] }, "frame_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 when scope_type is SCOPE_TYPE_FRAME", "type": "string", "maxLength": 200 } } }, "required_width": { "description": "Free-region width required for the footprint", "type": "number" }, "max_results": { "description": "Maximum ranked regions to return; unset uses the server default", "type": "integer" }, "required_height": { "description": "Free-region height required for the footprint", "type": "number" } }, "required": [ "required_width", "required_height" ] } }, "request_item_ids": { "maxItems": 50, "description": "Optional correlation IDs echoed back in response", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } }, "required": [ "requests" ] }, "TidyDirection": { "type": "string", "enum": [ "TIDY_DIRECTION_UNSPECIFIED", "TIDY_DIRECTION_AUTO", "TIDY_DIRECTION_HORIZONTAL", "TIDY_DIRECTION_VERTICAL" ] }, "VaniObjectType": { "type": "string", "enum": [ "VANI_OBJECT_TYPE_UNSPECIFIED", "VANI_OBJECT_TYPE_SHAPE", "VANI_OBJECT_TYPE_CONNECTOR", "VANI_OBJECT_TYPE_PICTURE", "VANI_OBJECT_TYPE_GROUP_SHAPE", "VANI_OBJECT_TYPE_DOMAIN_DIAGRAM", "VANI_OBJECT_TYPE_DIAGRAM", "VANI_OBJECT_TYPE_STRUCTURE", "VANI_OBJECT_TYPE_STRUCTURE_MINDMAP", "VANI_OBJECT_TYPE_STRUCTURE_KANBAN", "VANI_OBJECT_TYPE_STRUCTURE_STACK", "VANI_OBJECT_TYPE_TABLE", "VANI_OBJECT_TYPE_CHART", "VANI_OBJECT_TYPE_DATABASE_TABLE", "VANI_OBJECT_TYPE_STICKY_NOTE" ] }, "TidyObjectsRequest": { "type": "object", "properties": { "fixed_spacing": { "format": "float", "type": "string" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "direction": { "$ref": "#/components/schemas/TidyDirection" }, "spacing_mode": { "$ref": "#/components/schemas/TidySpacingMode" }, "preserve_order": { "type": "boolean" }, "target": { "$ref": "#/components/schemas/ObjectAlignTarget" } } }, "ObjectAlignTarget": { "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/ObjectAlignTarget_AlignReference" }, "target_bounds": { "$ref": "#/components/schemas/Bounds" } } }, "ConnectionOptions": { "type": "object", "properties": { "connector_type": { "$ref": "#/components/schemas/Connector_ConnectorType" }, "target_side": { "$ref": "#/components/schemas/Connector_ConnectionSide" }, "source_side": { "$ref": "#/components/schemas/Connector_ConnectionSide" } } }, "AgentReconnectConnectionPayload": { "type": "object", "properties": { "current_object": { "description": "Existing endpoint object to be replaced", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "new_object": { "description": "New endpoint object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "payload": { "description": "Shared reconnect options payload (new_side)", "type": "object", "properties": { "new_side": { "description": "Preferred side on new_object; UNKNOWN_SIDE lets server choose", "type": "string", "maxLength": 20, "enum": [ "UNKNOWN_SIDE", "NORTH", "EAST", "SOUTH", "WEST" ] } } }, "connection_object": { "description": "Existing connector object to reconnect", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "context": { "description": "Request context with zone scope", "type": "object", "properties": { "zone_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": "Target zone id (required)", "type": "string", "maxLength": 200 }, "validate_only": { "description": "Validate/dry-run mode when true", "type": "boolean" }, "actor_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}$|^[0-9]+$)$", "description": "Calling actor/agent id", "type": "string", "maxLength": 200 }, "base_revision_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional optimistic-concurrency token for mutating operations", "type": "string", "maxLength": 200 }, "request_id": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Client-supplied request correlation id", "type": "string", "maxLength": 200 } }, "required": [ "zone_id" ] } }, "required": [ "context", "connection_object", "current_object", "new_object" ] }, "FrameAlignTarget": { "type": "object", "properties": { "reference": { "$ref": "#/components/schemas/FrameAlignTarget_AlignReference" }, "target_bounds": { "$ref": "#/components/schemas/Bounds" } } }, "SpatialBatchGetObjectsRequest": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 50, "description": "Array of GetObjects sub-requests", "type": "array", "items": { "type": "object", "properties": { "object_types": { "maxItems": 20, "description": "Object-type filter; empty means all types", "type": "array", "items": { "type": "string", "maxLength": 60, "enum": [ "VANI_OBJECT_TYPE_UNSPECIFIED", "VANI_OBJECT_TYPE_SHAPE", "VANI_OBJECT_TYPE_CONNECTOR", "VANI_OBJECT_TYPE_PICTURE", "VANI_OBJECT_TYPE_GROUP_SHAPE", "VANI_OBJECT_TYPE_DOMAIN_DIAGRAM", "VANI_OBJECT_TYPE_DIAGRAM", "VANI_OBJECT_TYPE_STRUCTURE", "VANI_OBJECT_TYPE_STRUCTURE_MINDMAP", "VANI_OBJECT_TYPE_STRUCTURE_KANBAN", "VANI_OBJECT_TYPE_STRUCTURE_STACK", "VANI_OBJECT_TYPE_TABLE", "VANI_OBJECT_TYPE_CHART", "VANI_OBJECT_TYPE_DATABASE_TABLE", "VANI_OBJECT_TYPE_STICKY_NOTE" ] } }, "include_hidden": { "description": "Include hidden objects when true", "type": "boolean" }, "scope": { "description": "Optional scope selector; defaults to the full zone", "type": "object", "properties": { "percent_bounds": { "description": "Region refinement: bounds normalized to the selected container. Oneof with absolute_bounds", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "absolute_bounds": { "description": "Region refinement: absolute bounds in zone coordinates. Oneof with percent_bounds", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "scope_type": { "default": "SCOPE_TYPE_ZONE", "description": "Scope type selector; defaults to SCOPE_TYPE_ZONE", "type": "string", "maxLength": 50, "enum": [ "SCOPE_TYPE_UNSPECIFIED", "SCOPE_TYPE_ZONE", "SCOPE_TYPE_FRAME" ] }, "frame_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 when scope_type is SCOPE_TYPE_FRAME", "type": "string", "maxLength": 200 } } }, "max_results": { "description": "Maximum hits to return; unset uses the server default", "type": "integer" }, "include_locked": { "description": "Include locked objects when true", "type": "boolean" } } } }, "request_item_ids": { "maxItems": 50, "description": "Optional correlation IDs echoed back in response", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } }, "required": [ "requests" ] }, "BatchGetOccupiedBoundsResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/GetOccupiedBoundsResponse" } }, "error": { "$ref": "#/components/schemas/AgentError" }, "request_item_ids": { "type": "array", "items": { "type": "string" } } } }, "GetPlacementFeasibilityResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetPlacementFeasibilityResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "ContainerScope": { "type": "object", "properties": { "scope_type": { "$ref": "#/components/schemas/ContainerScope_ScopeType" } } }, "TidySpacingMode": { "type": "string", "enum": [ "TIDY_SPACING_MODE_UNSPECIFIED", "TIDY_SPACING_MODE_AUTO", "TIDY_SPACING_MODE_FIXED" ] }, "SpatialBatchSuggestPlacementRequest": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 50, "description": "requests. Max length: 2000000 (required)", "type": "array", "items": { "type": "object", "properties": { "padding": { "description": "Additional clearance after footprint fit is checked", "type": "number" }, "object_type": { "description": "Type of object to be placed", "type": "string", "maxLength": 60, "enum": [ "VANI_OBJECT_TYPE_UNSPECIFIED", "VANI_OBJECT_TYPE_SHAPE", "VANI_OBJECT_TYPE_CONNECTOR", "VANI_OBJECT_TYPE_PICTURE", "VANI_OBJECT_TYPE_GROUP_SHAPE", "VANI_OBJECT_TYPE_DOMAIN_DIAGRAM", "VANI_OBJECT_TYPE_DIAGRAM", "VANI_OBJECT_TYPE_STRUCTURE", "VANI_OBJECT_TYPE_STRUCTURE_MINDMAP", "VANI_OBJECT_TYPE_STRUCTURE_KANBAN", "VANI_OBJECT_TYPE_STRUCTURE_STACK", "VANI_OBJECT_TYPE_TABLE", "VANI_OBJECT_TYPE_CHART", "VANI_OBJECT_TYPE_DATABASE_TABLE", "VANI_OBJECT_TYPE_STICKY_NOTE" ] }, "near_object": { "description": "Optional nearby anchor object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "scope": { "description": "Optional scope selector; defaults to SCOPE_TYPE_ZONE", "type": "object", "properties": { "percent_bounds": { "description": "Region refinement: bounds normalized to the selected container. Oneof with absolute_bounds", "type": "object", "properties": { "right_pct": { "description": "Right edge as 0-1 fraction of zone width", "type": "number" }, "top_pct": { "description": "Top edge as 0-1 fraction of zone height", "type": "number" }, "bottom_pct": { "description": "Bottom edge as 0-1 fraction of zone height", "type": "number" }, "left_pct": { "description": "Left edge as 0-1 fraction of zone width", "type": "number" } } }, "absolute_bounds": { "description": "Region refinement: absolute bounds in zone coordinates. Oneof with percent_bounds", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } }, "scope_type": { "default": "SCOPE_TYPE_ZONE", "description": "Scope type selector; defaults to SCOPE_TYPE_ZONE", "type": "string", "maxLength": 50, "enum": [ "SCOPE_TYPE_UNSPECIFIED", "SCOPE_TYPE_ZONE", "SCOPE_TYPE_FRAME" ] }, "frame_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 when scope_type is SCOPE_TYPE_FRAME", "type": "string", "maxLength": 200 } } }, "required_width": { "description": "Free-region width required for the footprint", "type": "number" }, "max_results": { "description": "Maximum ranked placements to return; unset uses the server default", "type": "integer" }, "required_height": { "description": "Free-region height required for the footprint", "type": "number" } }, "required": [ "required_width", "required_height" ] } }, "request_item_ids": { "maxItems": 50, "description": "Optional correlation IDs echoed back in response", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } }, "required": [ "requests" ] }, "BatchGetPlacementFeasibilityResponse": { "type": "object", "properties": { "responses": { "type": "array", "items": { "$ref": "#/components/schemas/GetPlacementFeasibilityResponse" } }, "error": { "$ref": "#/components/schemas/AgentError" }, "request_item_ids": { "type": "array", "items": { "type": "string" } } } }, "GetFrameAlignmentStatusRequest": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/AlignMode" }, "frame_ids": { "type": "array", "items": { "type": "string" } }, "target": { "$ref": "#/components/schemas/FrameAlignTarget" } } }, "AlignMode": { "type": "string", "enum": [ "ALIGN_MODE_UNSPECIFIED", "ALIGN_LEFT_EDGE", "ALIGN_RIGHT_EDGE", "ALIGN_TOP_EDGE", "ALIGN_BOTTOM_EDGE", "ALIGN_HORIZONTAL_CENTER", "ALIGN_VERTICAL_CENTER", "DISTRIBUTE_HORIZONTAL", "DISTRIBUTE_VERTICAL" ] }, "AgentAlignFramesRequest": { "type": "object", "properties": { "mode": { "description": "Alignment or distribution mode", "type": "string", "maxLength": 50, "enum": [ "ALIGN_MODE_UNSPECIFIED", "ALIGN_LEFT_EDGE", "ALIGN_RIGHT_EDGE", "ALIGN_TOP_EDGE", "ALIGN_BOTTOM_EDGE", "ALIGN_HORIZONTAL_CENTER", "ALIGN_VERTICAL_CENTER", "DISTRIBUTE_HORIZONTAL", "DISTRIBUTE_VERTICAL" ] }, "frame_ids": { "minItems": 2, "maxItems": 500, "description": "Frames to align or distribute (minimum 2)", "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": 200 } }, "target": { "description": "Optional alignment target; defaults to WITHIN_SELECTION", "type": "object", "properties": { "reference": { "default": "WITHIN_SELECTION", "description": "Alignment reference; defaults to WITHIN_SELECTION", "type": "string", "maxLength": 50, "enum": [ "FRAME_ALIGN_REFERENCE_UNSPECIFIED", "WITHIN_SELECTION", "TARGET_BOUNDS" ] }, "target_bounds": { "description": "Explicit bounds, used when reference is TARGET_BOUNDS", "type": "object", "properties": { "x": { "description": "Left position in canvas units", "type": "number" }, "width": { "description": "Width in canvas units", "type": "number" }, "y": { "description": "Top position in canvas units", "type": "number" }, "height": { "description": "Height in canvas units", "type": "number" } } } } } }, "required": [ "frame_ids", "mode" ] }, "AgentPlaceObjectRelativeRequest": { "type": "object", "properties": { "target_object": { "description": "Reference target object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "source_object": { "description": "Object to move", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } }, "constraint": { "description": "Optional placement constraints", "type": "object", "properties": { "keep_inside_container": { "description": "Clamp final bounds within the primary container", "type": "boolean" }, "avoid_overlap": { "description": "Reject or adjust placements that collide with other objects", "type": "boolean" }, "cross_axis_alignment": { "default": "CENTER", "description": "Cross-axis alignment; defaults to CENTER", "type": "string", "maxLength": 40, "enum": [ "CROSS_AXIS_ALIGNMENT_UNSPECIFIED", "START", "CENTER", "END" ] }, "gap": { "description": "Requested edge-to-edge spacing between source and target (>= 0)", "type": "number" }, "snap_to_grid": { "description": "Snap the final position to layout guides/grid", "type": "boolean" } } }, "relation": { "description": "Desired relation from source to target", "type": "string", "maxLength": 60, "enum": [ "ANCHOR_RELATION_UNSPECIFIED", "ANCHOR_RELATION_LEFT", "ANCHOR_RELATION_RIGHT", "ANCHOR_RELATION_TOP", "ANCHOR_RELATION_BOTTOM" ] } }, "required": [ "source_object", "target_object", "relation" ] }, "GetPlacementFeasibilityRequest": { "type": "object", "properties": { "padding": { "format": "float", "type": "string" }, "object_type": { "$ref": "#/components/schemas/VaniObjectType" }, "near_object": { "$ref": "#/components/schemas/ObjectRef" }, "scope": { "$ref": "#/components/schemas/SpatialScope" }, "required_width": { "format": "float", "type": "string" }, "required_height": { "format": "float", "type": "string" } } }, "SpatialScope": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "absolute_bounds", "percent_bounds" ], "name": "region" } ], "properties": { "percent_bounds": { "$ref": "#/components/schemas/PercentBounds" }, "absolute_bounds": { "$ref": "#/components/schemas/Bounds" }, "scope_type": { "$ref": "#/components/schemas/SpatialScope_ScopeType" }, "frame_id": { "type": "string" } } }, "AnchoringConstraint": { "type": "object", "properties": { "keep_inside_container": { "type": "boolean" }, "avoid_overlap": { "type": "boolean" }, "cross_axis_alignment": { "$ref": "#/components/schemas/AnchoringConstraint_CrossAxisAlignment" }, "gap": { "format": "float", "type": "string" }, "snap_to_grid": { "type": "boolean" } } }, "GetConnectionFeasibilityRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/ConnectionOptions" }, "target_object": { "$ref": "#/components/schemas/ObjectRef" }, "source_object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "source_object", "target_object" ] }, "PercentBounds": { "type": "object", "properties": { "right_pct": { "format": "float", "type": "string" }, "top_pct": { "format": "float", "type": "string" }, "bottom_pct": { "format": "float", "type": "string" }, "left_pct": { "format": "float", "type": "string" } } }, "GetClearanceAroundObjectRequest": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "include_hidden": { "type": "boolean" }, "scope": { "$ref": "#/components/schemas/SpatialComputationScope" }, "include_locked": { "type": "boolean" }, "object": { "$ref": "#/components/schemas/ObjectRef" } } }, "SuggestPlacementResponse": { "type": "object", "properties": { "candidates": { "type": "array", "items": { "$ref": "#/components/schemas/CandidateRegion" } }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "GetRelationEvidenceRequest": { "type": "object", "properties": { "relation_context": { "$ref": "#/components/schemas/RelationContext" }, "target_object": { "$ref": "#/components/schemas/ObjectRef" }, "source_object": { "$ref": "#/components/schemas/ObjectRef" }, "relation_types": { "type": "array", "items": { "$ref": "#/components/schemas/RelationType" } } }, "required": [ "source_object", "target_object" ] }, "GetTraversalIndexResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TraversalIndexResult" }, "error": { "$ref": "#/components/schemas/AgentError" }, "effective_scope": { "$ref": "#/components/schemas/ContainerScope" } } }, "GetObjectAncestorsRequest": { "type": "object", "properties": { "max_levels": { "format": "int32", "type": "string" }, "object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "object" ] }, "RelationContext": { "type": "object", "properties": { "containment_context_type": { "$ref": "#/components/schemas/ContainmentContextType" } } }, "VisualDirection": { "type": "string", "enum": [ "VISUAL_DIRECTION_UNSPECIFIED", "UP", "DOWN", "LEFT", "RIGHT", "FRONT", "BACK" ] }, "GetTraversalSequenceRequest": { "type": "object", "properties": { "traversal_scope": { "$ref": "#/components/schemas/ContainerScope" }, "payload": { "$ref": "#/components/schemas/VaniTraversalSequencePayload" }, "anchor": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "anchor" ] }, "GetObjectChildrenRequest": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "payload": { "$ref": "#/components/schemas/ChildrenPayload" }, "object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "object" ] }, "GetTraversalIndexRequest": { "type": "object", "properties": { "traversal_scope": { "$ref": "#/components/schemas/ContainerScope" }, "payload": { "$ref": "#/components/schemas/VaniTraversalIndexPayload" }, "object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "object" ] }, "FindRelatedObjectsRequest": { "type": "object", "properties": { "relation_context": { "$ref": "#/components/schemas/RelationContext" }, "relation_query": { "type": "string" }, "max_depth": { "format": "int32", "type": "string" }, "scope": { "$ref": "#/components/schemas/SpatialComputationScope" }, "anchor": { "$ref": "#/components/schemas/ObjectRef" }, "relation_types": { "type": "array", "items": { "$ref": "#/components/schemas/RelationType" } }, "max_results": { "format": "int32", "type": "string" } }, "required": [ "anchor" ] }, "VaniTraversalFilter": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "include_hidden": { "type": "boolean" }, "include_locked": { "type": "boolean" } } }, "DescendantFlatSelection": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "all", "range", "index_set" ], "name": "selector" } ], "properties": { "all": { "type": "boolean" }, "index_set": { "$ref": "#/components/schemas/IndexSet" }, "range": { "$ref": "#/components/schemas/IndexRange" } } }, "GetDistanceBetweenObjectsRequest": { "type": "object", "properties": { "target_object": { "$ref": "#/components/schemas/ObjectRef" }, "source_object": { "$ref": "#/components/schemas/ObjectRef" } } }, "ContainmentContextType": { "type": "string", "enum": [ "CONTAINMENT_CONTEXT_TYPE_UNSPECIFIED", "GROUP", "FRAME" ] }, "GetTraversalWindowResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetTraversalWindowResult" }, "error": { "$ref": "#/components/schemas/AgentError" }, "effective_scope": { "$ref": "#/components/schemas/ContainerScope" } } }, "GetTraversalWindowResult": { "type": "object", "properties": { "before_objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "after_objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } }, "meta": { "$ref": "#/components/schemas/TraversalWindowResult" } } }, "DescendantPathSelection": { "type": "object", "properties": { "patterns": { "type": "array", "items": { "$ref": "#/components/schemas/DescendantPathSelection_PathPattern" } } } }, "DescendantPathSelection_PathSegmentSelection": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "index", "range", "index_set" ], "name": "selector" } ], "properties": { "index_set": { "$ref": "#/components/schemas/IndexSet" }, "index": { "format": "int32", "type": "string" }, "range": { "$ref": "#/components/schemas/IndexRange" } } }, "GetTraversalSequenceResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetTraversalSequenceResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "IndexRange": { "type": "object", "properties": { "start_index": { "format": "int32", "type": "string" }, "end_index": { "format": "int32", "type": "string" } } }, "DescendantsPayload": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "flat_selection", "path_selection" ], "name": "selection" } ], "properties": { "max_depth": { "format": "int32", "type": "string" }, "max_results": { "format": "int32", "type": "string" }, "flat_selection": { "$ref": "#/components/schemas/DescendantFlatSelection" }, "path_selection": { "$ref": "#/components/schemas/DescendantPathSelection" } } }, "GetConnectedObjectsRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/ConnectedObjectsPayload" }, "scope": { "$ref": "#/components/schemas/ContainerScope" }, "anchor": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "anchor" ] }, "ChildrenPayload": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "all", "range", "index_set" ], "name": "selection" } ], "properties": { "all": { "type": "boolean" }, "index_set": { "$ref": "#/components/schemas/IndexSet" }, "range": { "$ref": "#/components/schemas/IndexRange" }, "max_results": { "format": "int32", "type": "string" } } }, "GetTraversalSequenceResult": { "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRef" } } } }, "DescendantPathSelection_PathPattern": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/components/schemas/DescendantPathSelection_PathSegmentSelection" } } } }, "TraversalDirection": { "type": "string", "enum": [ "TRAVERSAL_DIRECTION_UNSPECIFIED", "TRAVERSAL_DIRECTION_NEXT", "TRAVERSAL_DIRECTION_PREVIOUS" ] }, "GetTraversalWindowRequest": { "type": "object", "properties": { "traversal_scope": { "$ref": "#/components/schemas/ContainerScope" }, "payload": { "$ref": "#/components/schemas/VaniTraversalWindowPayload" }, "anchor": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "anchor" ] }, "TraversalWindowResult": { "type": "object", "properties": { "anchor_index_path": { "type": "array", "items": { "format": "int32", "type": "string" } } } }, "RelationType": { "type": "string", "enum": [ "RELATION_TYPE_UNSPECIFIED", "CONNECTED_BY_EDGE", "CO_CONTAINED", "SAME_STRUCTURE", "PARENT", "CHILD", "ANCESTOR", "DESCENDANT", "SIBLING" ] }, "GetVisualSequenceRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/VaniVisualSequencePayload" }, "scope": { "$ref": "#/components/schemas/SpatialComputationScope" }, "anchor": { "$ref": "#/components/schemas/ObjectRef" } } }, "VaniTraversalWindowPayload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/VaniTraversalFilter" }, "after_count": { "format": "int32", "type": "string" }, "before_count": { "format": "int32", "type": "string" }, "wrap": { "type": "boolean" } } }, "GetObjectDescendantsRequest": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "payload": { "$ref": "#/components/schemas/DescendantsPayload" }, "object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "object" ] }, "IndexSet": { "type": "object", "properties": { "indices": { "type": "array", "items": { "format": "int32", "type": "string" } } } }, "TraversalIndexResult": { "type": "object", "properties": { "index_path": { "type": "array", "items": { "format": "int32", "type": "string" } } } }, "VaniObjectsAroundPayload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/VaniVisualFilter" }, "max_results": { "format": "int32", "type": "string" } } }, "VaniTraversalSequencePayload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/VaniTraversalFilter" }, "max_results": { "format": "int32", "type": "string" }, "wrap": { "type": "boolean" }, "direction": { "$ref": "#/components/schemas/TraversalDirection" } } }, "VaniVisualFilter": { "type": "object", "properties": { "object_types": { "type": "array", "items": { "$ref": "#/components/schemas/VaniObjectType" } }, "include_hidden": { "type": "boolean" }, "include_locked": { "type": "boolean" } } }, "GetObjectParentsRequest": { "type": "object", "properties": { "object": { "$ref": "#/components/schemas/ObjectRef" } }, "required": [ "object" ] }, "VaniTraversalIndexPayload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/VaniTraversalFilter" } } }, "VaniVisualSequencePayload": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/VaniVisualFilter" }, "max_results": { "format": "int32", "type": "string" }, "wrap": { "type": "boolean" }, "direction": { "$ref": "#/components/schemas/VisualDirection" } } }, "GetObjectsAroundRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/VaniObjectsAroundPayload" }, "scope": { "$ref": "#/components/schemas/SpatialComputationScope" }, "anchor": { "$ref": "#/components/schemas/ObjectRef" } } }, "ConnectedObjectsPayload": { "type": "object", "properties": { "max_depth": { "format": "int32", "type": "string" }, "max_results": { "format": "int32", "type": "string" }, "direction": { "$ref": "#/components/schemas/ConnectionDirection" } } }, "ConnectionDirection": { "type": "string", "enum": [ "CONNECTION_DIRECTION_UNSPECIFIED", "CONNECTION_DIRECTION_ANY", "CONNECTION_DIRECTION_INCOMING", "CONNECTION_DIRECTION_OUTGOING", "CONNECTION_DIRECTION_UNDIRECTED" ] }, "AgentDatabaseTableQueryRecordsRequest": { "type": "object", "properties": { "query": { "description": "Query spec (filter / selection / page)", "type": "object", "properties": { "filter": { "description": "Row filter; unset = all rows", "type": "object", "properties": { "mode": { "description": "AND (default) / OR", "type": "string", "maxLength": 5, "enum": [ "AND", "OR" ] }, "conditions": { "maxItems": 200, "description": "Conditions combined by mode", "type": "array", "items": { "type": "object", "properties": { "text_match": { "description": "Substring match", "type": "object", "properties": { "op": { "description": "CONTAINS / STARTS_WITH / ENDS_WITH", "type": "string", "maxLength": 20, "enum": [ "CONTAINS", "STARTS_WITH", "ENDS_WITH" ] }, "case_sensitive": { "description": "Default false (case-insensitive)", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Search text", "type": "string", "maxLength": 5000 } } }, "comparison": { "description": "Scalar comparison", "type": "object", "properties": { "op": { "description": "EQ / NEQ / GT / GTE / LT / LTE", "type": "string", "maxLength": 10, "enum": [ "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "operand": { "description": "Right-hand side", "type": "object", "properties": { "column": { "description": "Another column in this table", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "value": { "description": "Literal comparand", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } } }, "emptiness": { "description": "Empty / not-empty", "type": "object", "properties": { "op": { "description": "IS_EMPTY / IS_NOT_EMPTY", "type": "string", "maxLength": 20, "enum": [ "IS_EMPTY", "IS_NOT_EMPTY" ] } } }, "column": { "description": "Column under test", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "membership": { "description": "Multi-select / relation contains", "type": "object", "properties": { "mode": { "description": "HAS_ANY / HAS_ALL / HAS_NONE", "type": "string", "maxLength": 20, "enum": [ "HAS_ANY", "HAS_ALL", "HAS_NONE" ] }, "values": { "maxItems": 200, "description": "Option ids or linked row ids", "type": "array", "items": { "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } }, "between": { "description": "Inclusive range", "type": "object", "properties": { "high": { "description": "Inclusive upper bound", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } }, "low": { "description": "Inclusive lower bound", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } }, "required": [ "column" ] } } } }, "page": { "description": "Paging", "type": "object", "properties": { "offset": { "description": "Rows to skip", "type": "integer" }, "limit": { "description": "Max rows; 0 = server default", "type": "integer" } } }, "rows": { "description": "Row selection arm", "type": "object", "properties": { "columns": { "maxItems": 50, "description": "Projection; empty = all columns", "type": "array", "items": { "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] } }, "sort": { "maxItems": 50, "description": "Sort order", "type": "array", "items": { "type": "object", "properties": { "column": { "description": "Sort column", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "order": { "description": "ASC (default) / DESC", "type": "string", "maxLength": 5, "enum": [ "ASC", "DESC" ] } } } } } }, "aggregate": { "description": "Aggregate selection arm", "type": "object", "properties": { "having": { "maxItems": 200, "description": "Post-aggregation filter", "type": "array", "items": { "type": "object", "properties": { "op": { "description": "Comparison operator", "type": "string", "maxLength": 10, "enum": [ "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "aggregation": { "description": "Aggregate under test", "type": "object", "properties": { "concat_separator": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Separator for CONCAT / CONCAT_UNIQUE", "type": "string", "maxLength": 20 }, "fn": { "description": "Summary function", "type": "object", "properties": { "date": { "description": "DATE columns", "type": "string", "maxLength": 40, "enum": [ "EARLIEST", "LATEST", "DATE_RANGE" ] }, "number": { "description": "NUMBER / RATING columns", "type": "string", "maxLength": 40, "enum": [ "SUM", "AVG", "MIN", "MAX", "MEDIAN", "RANGE" ] }, "boolean": { "description": "CHECKBOX / TOGGLE columns", "type": "string", "maxLength": 40, "enum": [ "CHECKED", "UNCHECKED", "PERCENT_CHECKED", "PERCENT_UNCHECKED" ] }, "common": { "description": "Applies to any column type", "type": "string", "maxLength": 40, "enum": [ "COUNT", "COUNT_EMPTY", "COUNT_NOT_EMPTY", "COUNT_UNIQUE", "PERCENT_EMPTY", "PERCENT_NOT_EMPTY" ] }, "text": { "description": "Text and string-like columns", "type": "string", "maxLength": 40, "enum": [ "CONCAT", "CONCAT_UNIQUE" ] } } }, "column": { "description": "Column aggregated", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] } } }, "value": { "description": "Comparand", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } }, "group_by": { "maxItems": 50, "description": "Grouping columns", "type": "array", "items": { "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] } }, "sort": { "maxItems": 200, "description": "Group ordering", "type": "array", "items": { "type": "object", "properties": { "group_by_column": { "description": "Order by a grouping column", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "aggregation": { "description": "Order by an aggregate", "type": "object", "properties": { "concat_separator": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Separator for CONCAT / CONCAT_UNIQUE", "type": "string", "maxLength": 20 }, "fn": { "description": "Summary function", "type": "object", "properties": { "date": { "description": "DATE columns", "type": "string", "maxLength": 40, "enum": [ "EARLIEST", "LATEST", "DATE_RANGE" ] }, "number": { "description": "NUMBER / RATING columns", "type": "string", "maxLength": 40, "enum": [ "SUM", "AVG", "MIN", "MAX", "MEDIAN", "RANGE" ] }, "boolean": { "description": "CHECKBOX / TOGGLE columns", "type": "string", "maxLength": 40, "enum": [ "CHECKED", "UNCHECKED", "PERCENT_CHECKED", "PERCENT_UNCHECKED" ] }, "common": { "description": "Applies to any column type", "type": "string", "maxLength": 40, "enum": [ "COUNT", "COUNT_EMPTY", "COUNT_NOT_EMPTY", "COUNT_UNIQUE", "PERCENT_EMPTY", "PERCENT_NOT_EMPTY" ] }, "text": { "description": "Text and string-like columns", "type": "string", "maxLength": 40, "enum": [ "CONCAT", "CONCAT_UNIQUE" ] } } }, "column": { "description": "Column aggregated", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] } } }, "order": { "description": "ASC / DESC", "type": "string", "maxLength": 5, "enum": [ "ASC", "DESC" ] } } } }, "aggregations": { "maxItems": 200, "description": "Summary functions", "type": "array", "items": { "type": "object", "properties": { "concat_separator": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Separator for CONCAT / CONCAT_UNIQUE", "type": "string", "maxLength": 20 }, "fn": { "description": "Summary function", "type": "object", "properties": { "date": { "description": "DATE columns", "type": "string", "maxLength": 40, "enum": [ "EARLIEST", "LATEST", "DATE_RANGE" ] }, "number": { "description": "NUMBER / RATING columns", "type": "string", "maxLength": 40, "enum": [ "SUM", "AVG", "MIN", "MAX", "MEDIAN", "RANGE" ] }, "boolean": { "description": "CHECKBOX / TOGGLE columns", "type": "string", "maxLength": 40, "enum": [ "CHECKED", "UNCHECKED", "PERCENT_CHECKED", "PERCENT_UNCHECKED" ] }, "common": { "description": "Applies to any column type", "type": "string", "maxLength": 40, "enum": [ "COUNT", "COUNT_EMPTY", "COUNT_NOT_EMPTY", "COUNT_UNIQUE", "PERCENT_EMPTY", "PERCENT_NOT_EMPTY" ] }, "text": { "description": "Text and string-like columns", "type": "string", "maxLength": 40, "enum": [ "CONCAT", "CONCAT_UNIQUE" ] } } }, "column": { "description": "Column aggregated", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] } } } }, "include_record_ids": { "description": "Return each group's row ids", "type": "boolean" } } } } }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table" ] }, "GetParagraphTextPayload": { "type": "object", "properties": { "range": { "$ref": "#/components/schemas/ParagraphIndexRange" } } }, "AgentDatabaseTableUpdateColumnRequest": { "type": "object", "properties": { "set_constraints": { "description": "Set-constraints change (required/unique)", "type": "object", "properties": { "unique": { "description": "Values must be unique across rows", "type": "boolean" }, "required": { "description": "Value must be present", "type": "boolean" } } }, "retype": { "description": "Retype change (target type)", "type": "object", "properties": { "new_type": { "description": "New column type", "type": "string", "maxLength": 40, "enum": [ "TEXT", "NUMBER", "CHECKBOX", "TOGGLE", "SELECT", "MULTI_SELECT", "CATEGORY", "DATE", "PERSON", "PHONE", "EMAIL", "URL", "RATING", "RELATION", "LOOKUP", "ROLLUP" ] } }, "required": [ "new_type" ] }, "rename": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "New column name (rename change)", "type": "string", "maxLength": 2000 }, "column": { "description": "Column ref (column id)", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] }, "set_options": { "description": "Set-options change (full option list)", "type": "object", "properties": { "options": { "maxItems": 200, "description": "Full option list", "type": "array", "items": { "type": "object", "properties": { "color": { "description": "Option colour", "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": { "pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$", "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" } } } } }, "id": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Option id — equal to the option's current label; send it to rename", "type": "string", "maxLength": 500 }, "value": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Option label", "type": "string", "maxLength": 500 } } } } }, "required": [ "options" ] }, "set_default": { "description": "Set-default change: the default cell value itself", "type": "object", "properties": { "value": { "description": "The typed cell value", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } }, "required": [ "table", "column" ] }, "GetCellTextResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetTextResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "UnmergeCellResult": { "type": "object", "properties": { "anchor_cell": { "$ref": "#/components/schemas/TableCellRef" }, "unmerged_range": { "$ref": "#/components/schemas/CellRectRange" } } }, "CellRectRange": { "type": "object", "properties": { "end_column_index": { "format": "int32", "type": "string" }, "start_column_index": { "format": "int32", "type": "string" }, "start_row_index": { "format": "int32", "type": "string" }, "end_row_index": { "format": "int32", "type": "string" } } }, "GetParagraphTextResult": { "type": "object", "properties": { "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/ParagraphTextItem" } } } }, "AgentDeleteRowsRequest": { "type": "object", "properties": { "payload": { "description": "DeleteRows payload", "type": "object", "properties": { "range": { "description": "Row range to delete", "type": "object", "properties": { "start_index": { "description": "Inclusive start table index (row or column)", "type": "integer" }, "end_index": { "description": "Exclusive end table index", "type": "integer" } }, "required": [ "start_index", "end_index" ] } }, "required": [ "range" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "payload" ] }, "GetCellParagraphCountResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetParagraphCountResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "GetCellParagraphCountRequest": { "type": "object", "properties": { "cell": { "$ref": "#/components/schemas/TableCellRef" }, "table": { "$ref": "#/components/schemas/ObjectRef" } } }, "GetTextLengthResult": { "type": "object", "properties": { "length": { "format": "int32", "type": "string" } } }, "GetCellTextLengthRequest": { "type": "object", "properties": { "cell": { "$ref": "#/components/schemas/TableCellRef" }, "table": { "$ref": "#/components/schemas/ObjectRef" } } }, "GetCellTextLengthResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetTextLengthResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "ParagraphIndexRange": { "type": "object", "properties": { "end_paragraph_index": { "format": "int32", "type": "string" }, "start_paragraph_index": { "format": "int32", "type": "string" } } }, "AgentInsertColumnsRequest": { "type": "object", "properties": { "payload": { "description": "InsertColumns payload", "type": "object", "properties": { "anchor_index": { "description": "Anchor column index in [0, column_count - 1]", "type": "integer" }, "count": { "description": "Number of columns to insert (> 0)", "type": "integer" }, "position": { "description": "Insert position relative to anchor_index", "type": "string", "maxLength": 40, "enum": [ "INSERT_POSITION_UNSPECIFIED", "BEFORE", "AFTER" ] } }, "required": [ "anchor_index" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "payload" ] }, "GetCellTextRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/GetCellTextPayload" }, "cell": { "$ref": "#/components/schemas/TableCellRef" }, "table": { "$ref": "#/components/schemas/ObjectRef" } } }, "AgentDatabaseTableUpdateRecordRequest": { "type": "object", "properties": { "cells": { "minItems": 1, "maxItems": 50, "description": "Cell assignments to set or clear", "type": "array", "items": { "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Target column id", "type": "string", "maxLength": 200 }, "column": { "description": "Target column ref", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "clear": { "description": "Clear the cell", "type": "object", "properties": {} }, "value": { "description": "Value to set", "type": "object", "properties": { "value": { "description": "The typed cell value", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } } } }, "record": { "description": "Record ref (row id)", "type": "object", "properties": { "row_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Row id", "type": "string", "maxLength": 200 } }, "required": [ "row_id" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "record", "cells" ] }, "MergeCellsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/MergeCellsResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentUnmergeCellRequest": { "type": "object", "properties": { "payload": { "description": "UnmergeCell payload. Must contain 'cell' ({row_index, column_index}) — do NOT use 'range'. Example: {\"cell\": {\"row_index\": 0, \"column_index\": 1}}", "type": "object", "properties": { "cell": { "description": "Any cell within the merged region to unmerge, specified as {row_index, column_index}. This must be a 'cell' object — do NOT use a 'range' object here.", "type": "object", "properties": { "row_index": { "description": "Zero-based row index", "type": "integer" }, "column_index": { "description": "Zero-based column index", "type": "integer" } } } }, "required": [ "cell" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "payload" ] }, "EditCellTextResult": { "type": "object", "properties": { "text": { "$ref": "#/components/schemas/EditTextResult" } } }, "DeleteRowsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TableSizeResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "GetTextResult": { "type": "object", "properties": { "text": { "type": "string" } } }, "GetTableSizeRequest": { "type": "object", "properties": { "table": { "$ref": "#/components/schemas/ObjectRef" } } }, "GetCellParagraphTextRequest": { "type": "object", "properties": { "payload": { "$ref": "#/components/schemas/GetCellParagraphTextPayload" }, "cell": { "$ref": "#/components/schemas/TableCellRef" }, "table": { "$ref": "#/components/schemas/ObjectRef" } } }, "GetCellParagraphTextResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/GetParagraphTextResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentMergeCellsRequest": { "type": "object", "properties": { "payload": { "description": "MergeCells payload", "type": "object", "properties": { "range": { "description": "Rectangular cell range to merge", "type": "object", "properties": { "end_column_index": { "description": "Exclusive end column index", "type": "integer" }, "start_column_index": { "description": "Inclusive start column index", "type": "integer" }, "start_row_index": { "description": "Inclusive start row index", "type": "integer" }, "end_row_index": { "description": "Exclusive end row index", "type": "integer" } }, "required": [ "start_row_index", "end_row_index", "start_column_index", "end_column_index" ] } }, "required": [ "range" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "payload" ] }, "MergeCellsResult": { "type": "object", "properties": { "anchor_cell": { "$ref": "#/components/schemas/TableCellRef" }, "merged_range": { "$ref": "#/components/schemas/CellRectRange" } } }, "AgentDatabaseTableAddColumnRequest": { "type": "object", "properties": { "column": { "description": "Column spec (name, type, options, default, constraints)", "type": "object", "properties": { "lookup": { "description": "LOOKUP configuration", "type": "object", "properties": { "source_column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column read from the related table", "type": "string", "maxLength": 200 }, "relation_column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "RELATION column to follow", "type": "string", "maxLength": 200 } } }, "unique": { "description": "Values must be unique across rows", "type": "boolean" }, "name": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Column header", "type": "string", "maxLength": 500 }, "options": { "maxItems": 200, "description": "SELECT / MULTI_SELECT options", "type": "array", "items": { "type": "object", "properties": { "color": { "description": "Option colour", "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": { "pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$", "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" } } } } }, "id": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Option id — equal to the option's current label; send it to rename", "type": "string", "maxLength": 500 }, "value": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Option label", "type": "string", "maxLength": 500 } } } }, "default_value": { "description": "Default applied when a cell is absent", "type": "object", "properties": { "value": { "description": "The typed cell value", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } }, "type": { "description": "Column type", "type": "string", "maxLength": 40, "enum": [ "TEXT", "NUMBER", "CHECKBOX", "TOGGLE", "SELECT", "MULTI_SELECT", "CATEGORY", "DATE", "PERSON", "PHONE", "EMAIL", "URL", "RATING", "RELATION", "LOOKUP", "ROLLUP" ] }, "required": { "description": "Value must be present", "type": "boolean" }, "relation": { "description": "RELATION configuration", "type": "object", "properties": { "reciprocal_column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Paired RELATION column on the related table (two-way)", "type": "string", "maxLength": 200 }, "allow_multiple": { "description": "Single vs multiple linked rows", "type": "boolean" }, "related_table_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Table this column links rows to", "type": "string", "maxLength": 200 } } }, "rollup": { "description": "ROLLUP configuration", "type": "object", "properties": { "source_column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column aggregated on the related table", "type": "string", "maxLength": 200 }, "relation_column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "RELATION column to follow", "type": "string", "maxLength": 200 }, "aggregate": { "description": "Summary function", "type": "object", "properties": { "date": { "description": "DATE columns", "type": "string", "maxLength": 40, "enum": [ "EARLIEST", "LATEST", "DATE_RANGE" ] }, "number": { "description": "NUMBER / RATING columns", "type": "string", "maxLength": 40, "enum": [ "SUM", "AVG", "MIN", "MAX", "MEDIAN", "RANGE" ] }, "boolean": { "description": "CHECKBOX / TOGGLE columns", "type": "string", "maxLength": 40, "enum": [ "CHECKED", "UNCHECKED", "PERCENT_CHECKED", "PERCENT_UNCHECKED" ] }, "common": { "description": "Applies to any column type", "type": "string", "maxLength": 40, "enum": [ "COUNT", "COUNT_EMPTY", "COUNT_NOT_EMPTY", "COUNT_UNIQUE", "PERCENT_EMPTY", "PERCENT_NOT_EMPTY" ] }, "text": { "description": "Text and string-like columns", "type": "string", "maxLength": 40, "enum": [ "CONCAT", "CONCAT_UNIQUE" ] } } } } } } }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "column" ] }, "TableCellRef": { "type": "object", "properties": { "row_index": { "format": "int32", "type": "string" }, "column_index": { "format": "int32", "type": "string" } } }, "DeleteColumnsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TableSizeResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "GetCellParagraphTextPayload": { "type": "object", "properties": { "text": { "$ref": "#/components/schemas/GetParagraphTextPayload" } } }, "ParagraphTextItem": { "type": "object", "properties": { "paragraph_index": { "format": "int32", "type": "string" }, "text": { "type": "string" } } }, "EditCellTextResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/EditCellTextResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentDatabaseTableReorderColumnsRequest": { "type": "object", "properties": { "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] }, "order": { "minItems": 1, "maxItems": 50, "description": "Full desired column order (column refs)", "type": "array", "items": { "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] } } }, "required": [ "table", "order" ] }, "GetTableSizeResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TableSizeResult" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentSetCellTextRequest": { "type": "object", "properties": { "payload": { "description": "SetCellText payload", "type": "object", "properties": { "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "description": "Full replacement text for the cell", "type": "string", "maxLength": 500000 } }, "required": [ "text" ] }, "cell": { "description": "Target cell reference", "type": "object", "properties": { "row_index": { "description": "Zero-based row index", "type": "integer" }, "column_index": { "description": "Zero-based column index", "type": "integer" } } }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "cell", "payload" ] }, "TableSizeResult": { "type": "object", "properties": { "column_count": { "format": "int32", "type": "string" }, "row_count": { "format": "int32", "type": "string" } } }, "AgentDeleteColumnsRequest": { "type": "object", "properties": { "payload": { "description": "DeleteColumns payload", "type": "object", "properties": { "range": { "description": "Column range to delete", "type": "object", "properties": { "start_index": { "description": "Inclusive start table index (row or column)", "type": "integer" }, "end_index": { "description": "Exclusive end table index", "type": "integer" } }, "required": [ "start_index", "end_index" ] } }, "required": [ "range" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "payload" ] }, "AgentInsertRowsRequest": { "type": "object", "properties": { "payload": { "description": "InsertRows payload", "type": "object", "properties": { "anchor_index": { "description": "Anchor row index in [0, row_count - 1]", "type": "integer" }, "count": { "description": "Number of rows to insert (> 0)", "type": "integer" }, "position": { "description": "Insert position relative to anchor_index", "type": "string", "maxLength": 40, "enum": [ "INSERT_POSITION_UNSPECIFIED", "BEFORE", "AFTER" ] } }, "required": [ "anchor_index" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "payload" ] }, "GetParagraphCountResult": { "type": "object", "properties": { "paragraph_count": { "format": "int32", "type": "string" } } }, "GetCellTextPayload": { "type": "object", "properties": { "text": { "$ref": "#/components/schemas/GetTextPayload" } } }, "AgentDatabaseTableDeleteColumnRequest": { "type": "object", "properties": { "column": { "description": "Column ref (column id)", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "column" ] }, "InsertRowsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TableSizeResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "EditTextResult": { "type": "object", "properties": { "applied_range": { "$ref": "#/components/schemas/TextRange" } } }, "UnmergeCellResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/UnmergeCellResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentDatabaseTableAddRecordRequest": { "type": "object", "properties": { "cells": { "maxItems": 50, "description": "Keyed cell assignments (partial allowed)", "type": "array", "items": { "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Target column id", "type": "string", "maxLength": 200 }, "column": { "description": "Target column ref", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "clear": { "description": "Clear the cell", "type": "object", "properties": {} }, "value": { "description": "Value to set", "type": "object", "properties": { "value": { "description": "The typed cell value", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } } } }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table" ] }, "InsertColumnsResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/TableSizeResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" } } }, "AgentEditCellTextRequest": { "type": "object", "properties": { "payload": { "description": "EditCellText payload", "type": "object", "properties": { "text": { "description": "Text mutation payload (exactly one of range, cursor, or all_text)", "type": "object", "properties": { "cursor": { "description": "Cursor-scoped insert/delete mutation", "type": "object", "properties": { "cursor_index": { "description": "Cursor index on flattened text", "type": "integer" }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "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": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "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": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "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" ] } } } }, "required": [ "text" ] }, "cell": { "description": "Target cell reference", "type": "object", "properties": { "row_index": { "description": "Zero-based row index", "type": "integer" }, "column_index": { "description": "Zero-based column index", "type": "integer" } } }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "cell", "payload" ] }, "AgentDatabaseTableDeleteRecordsRequest": { "type": "object", "properties": { "filter": { "description": "Non-empty filter selecting rows to delete", "type": "object", "properties": { "mode": { "description": "AND (default) / OR", "type": "string", "maxLength": 5, "enum": [ "AND", "OR" ] }, "conditions": { "maxItems": 200, "description": "Conditions combined by mode", "type": "array", "items": { "type": "object", "properties": { "text_match": { "description": "Substring match", "type": "object", "properties": { "op": { "description": "CONTAINS / STARTS_WITH / ENDS_WITH", "type": "string", "maxLength": 20, "enum": [ "CONTAINS", "STARTS_WITH", "ENDS_WITH" ] }, "case_sensitive": { "description": "Default false (case-insensitive)", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "Search text", "type": "string", "maxLength": 5000 } } }, "comparison": { "description": "Scalar comparison", "type": "object", "properties": { "op": { "description": "EQ / NEQ / GT / GTE / LT / LTE", "type": "string", "maxLength": 10, "enum": [ "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "operand": { "description": "Right-hand side", "type": "object", "properties": { "column": { "description": "Another column in this table", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "value": { "description": "Literal comparand", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } } }, "emptiness": { "description": "Empty / not-empty", "type": "object", "properties": { "op": { "description": "IS_EMPTY / IS_NOT_EMPTY", "type": "string", "maxLength": 20, "enum": [ "IS_EMPTY", "IS_NOT_EMPTY" ] } } }, "column": { "description": "Column under test", "type": "object", "properties": { "column_id": { "pattern": "^(?:[A-Za-z0-9_\\-]{1,200})$", "description": "Column id", "type": "string", "maxLength": 200 } }, "required": [ "column_id" ] }, "membership": { "description": "Multi-select / relation contains", "type": "object", "properties": { "mode": { "description": "HAS_ANY / HAS_ALL / HAS_NONE", "type": "string", "maxLength": 20, "enum": [ "HAS_ANY", "HAS_ALL", "HAS_NONE" ] }, "values": { "maxItems": 200, "description": "Option ids or linked row ids", "type": "array", "items": { "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } }, "between": { "description": "Inclusive range", "type": "object", "properties": { "high": { "description": "Inclusive upper bound", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } }, "low": { "description": "Inclusive lower bound", "type": "object", "properties": { "date": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "DATE value", "type": "string", "maxLength": 100 }, "select": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "SELECT: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "rating": { "description": "RATING value", "type": "integer" }, "toggle": { "description": "TOGGLE value", "type": "boolean" }, "url": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "URL value", "type": "string", "maxLength": 2000 }, "relation": { "description": "RELATION: linked row ids", "type": "object", "properties": { "row_ids": { "maxItems": 200, "description": "Linked row ids in the related table", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "number": { "description": "NUMBER value", "type": "number" }, "multi_select": { "description": "MULTI_SELECT: chosen option ids", "type": "object", "properties": { "option_ids": { "maxItems": 200, "description": "Selected ColumnOption ids", "type": "array", "items": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "type": "string", "maxLength": 200 } } } }, "phone": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PHONE value", "type": "string", "maxLength": 100 }, "person": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "PERSON value", "type": "string", "maxLength": 500 }, "checkbox": { "description": "CHECKBOX value", "type": "boolean" }, "text": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "TEXT value", "type": "string", "maxLength": 50000 }, "category": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "CATEGORY: chosen ColumnOption id", "type": "string", "maxLength": 500 }, "email": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;\\\\'\\/!\\u0080-\\uFFFF\\s\"]+)$", "description": "EMAIL value", "type": "string", "maxLength": 500 } } } } } }, "required": [ "column" ] } } } }, "table": { "description": "Table object reference", "type": "object", "properties": { "zone_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": "Zone containing the table (optional; defaults to the zone in the request path)", "type": "string", "maxLength": 200 }, "object_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": "Table object id", "type": "string", "maxLength": 200 }, "frame_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 containing the table (optional; auto-resolved if omitted)", "type": "string", "maxLength": 200 } }, "required": [ "object_id" ] } }, "required": [ "table", "filter" ] }, "AgentApplyTextStyleRequest": { "type": "object", "properties": { "payload": { "description": "ApplyTextStyle payload", "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": "Optional font weight token", "type": "string", "maxLength": 100, "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": { "pattern": "^#?[0-9a-fA-F]{6}([0-9a-fA-F]{2})?$", "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": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "description": "Font display name", "type": "string", "maxLength": 500 }, "style": { "pattern": "^(?:[A-Za-z_0-9- ]+)$", "description": "Optional font style token", "type": "string", "maxLength": 200 } } } } }, "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 points (>= 0)", "type": "integer" }, "line": { "description": "Optional line-height multiplier (e.g. 1.5 = 150%)", "type": "number" }, "after": { "description": "Optional space after paragraph, in points (>= 0)", "type": "integer" } } }, "level": { "description": "Optional paragraph level", "type": "integer" }, "halign": { "description": "Optional paragraph alignment token", "type": "string", "maxLength": 50, "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] } } } } }, "object": { "description": "Target text-bearing object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } } }, "required": [ "object", "payload" ] }, "AgentEditTextRequest": { "type": "object", "properties": { "payload": { "description": "EditText payload", "type": "object", "properties": { "cursor": { "description": "Cursor-scoped insert/delete mutation", "type": "object", "properties": { "cursor_index": { "description": "Cursor index on flattened text", "type": "integer" }, "text": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "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": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "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": { "pattern": "^[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]*$", "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" ] } } }, "object": { "description": "Target text-bearing object", "type": "object", "properties": { "zone_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": "Zone containing the object", "type": "string", "maxLength": 200 }, "object_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 in the frame", "type": "string", "maxLength": 200 }, "frame_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 containing the object", "type": "string", "maxLength": 200 } } } }, "required": [ "object", "payload" ] }, "ApplyTextStyleResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/ApplyTextStyleResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" }, "object": { "$ref": "#/components/schemas/ObjectRef" } } }, "ApplyTextStyleResult": { "type": "object", "properties": { "affected_paragraph_count": { "format": "int32", "type": "string" }, "affected_portion_count": { "format": "int32", "type": "string" } } }, "EditTextResponse": { "type": "object", "properties": { "result": { "$ref": "#/components/schemas/EditTextResult" }, "mutation": { "$ref": "#/components/schemas/MutationMetadata" }, "error": { "$ref": "#/components/schemas/AgentError" }, "object": { "$ref": "#/components/schemas/ObjectRef" } } }, "UpdateObjectOp": { "type": "object", "properties": { "update_mask": { "$ref": "#/components/schemas/FieldMask" }, "value": { "$ref": "#/components/schemas/VaniGraphicObject" }, "object": { "$ref": "#/components/schemas/ObjectRef" } } }, "Color_HSBColor": { "type": "object", "properties": { "saturation": { "format": "float", "type": "string" }, "brightness": { "format": "float", "type": "string" }, "hue": { "format": "float", "type": "string" } } }, "Chart_PieChart_RepresentativePie": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "position", "percent_value", "value" ], "name": "split_data" } ], "properties": { "percent_value": { "format": "float", "type": "string" }, "size": { "format": "int32", "type": "string" }, "position": { "format": "int32", "type": "string" }, "type": { "$ref": "#/components/schemas/Chart_PieChart_RepresentativePie_RepresentativePieType" }, "value": { "format": "float", "type": "string" } } }, "Chart_PieChart_RepresentativePie_RepresentativePieType": { "type": "string", "enum": [ "BAR", "PIE" ] }, "Structure_SpacingCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Structure_Spacing_SpacingTypeCamelCase" }, "manual": { "format": "float", "type": "string" } } }, "Table_CellBorder": { "type": "object", "properties": { "all": { "$ref": "#/components/schemas/Stroke" }, "top": { "$ref": "#/components/schemas/Stroke" }, "left": { "$ref": "#/components/schemas/Stroke" }, "bottom": { "$ref": "#/components/schemas/Stroke" }, "right": { "$ref": "#/components/schemas/Stroke" } } }, "TextMatchCamelCase": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/TextMatchOpCamelCase" }, "caseSensitive": { "type": "boolean" }, "text": { "type": "string" } } }, "Chart_LineChart": { "type": "object", "properties": { "up_bar": { "$ref": "#/components/schemas/Fill" }, "down_bar": { "$ref": "#/components/schemas/Fill" }, "high_low_lines": { "$ref": "#/components/schemas/Stroke" }, "line_settings": { "$ref": "#/components/schemas/Chart_LineSetting" }, "drop_lines": { "$ref": "#/components/schemas/Stroke" }, "grouping": { "$ref": "#/components/schemas/Chart_Grouping" } } }, "Picture": { "type": "object", "properties": { "media": { "$ref": "#/components/schemas/AssetRef" }, "filters": { "$ref": "#/components/schemas/PictureFilters" }, "properties": { "$ref": "#/components/schemas/GraphicObjectProperties" } } }, "LineToCamelCase": { "type": "object", "properties": { "point": { "$ref": "#/components/schemas/PointCamelCase" } } }, "ParaStyleCamelCase": { "type": "object", "properties": { "listStyle": { "$ref": "#/components/schemas/ParaStyle_ListStyleCamelCase" }, "spacing": { "$ref": "#/components/schemas/ParaStyle_SpacingCamelCase" }, "level": { "format": "int32", "type": "string" }, "halign": { "$ref": "#/components/schemas/HorizontalAlignTypeCamelCase" }, "portionStyle": { "$ref": "#/components/schemas/PortionStyleCamelCase" } } }, "DomainDiagram_ErdNode": { "type": "object", "properties": { "erd": { "$ref": "#/components/schemas/ERDKitSymbol" }, "id": { "type": "string" } } }, "Space": { "type": "object", "properties": { "zone_ids": { "type": "array", "items": { "type": "string" } }, "spec_version": { "$ref": "#/components/schemas/SpecVersion" }, "manifest": { "$ref": "#/components/schemas/SpaceManifest" }, "name": { "type": "string" }, "id": { "type": "string" }, "style_manifest_id": { "type": "string" } } }, "DatabaseTable_DatabaseRow_DatabaseCellCamelCase": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "$ref": "#/components/schemas/DatabaseValueCamelCase" } } }, "Shape_Basic_Triangle": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_Triangle_TriangleType" } } }, "DatabaseTable_DatabaseColumn_CategoryColumn": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_CategoryColumn_Category" } } } }, "DatabaseTable_DatabaseColumn_CategoryColumnCamelCase": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_CategoryColumn_CategoryCamelCase" } } } }, "MathematicalSymbolType": { "type": "string", "enum": [ "MATHEMATICAL_SYMBOL_TYPE_UNSPECIFIED", "PLUS", "MINUS", "MULTIPLY", "DIVIDE", "EQUAL", "NOT_EQUAL" ] }, "DatabaseTable_DatabaseColumn_ColumnOption": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/Color" }, "id": { "type": "string" }, "value": { "type": "string" } } }, "PortionStyle_FontNameCamelCase": { "type": "object", "properties": { "name": { "type": "string" }, "style": { "type": "string" } } }, "ComparisonOpCamelCase": { "type": "string", "enum": [ "COMPARISON_OP_UNSPECIFIED", "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "PortionStyle": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "font_name", "font_id" ], "name": "font" } ], "properties": { "font_id": { "type": "string" }, "fontweight": { "$ref": "#/components/schemas/PortionStyle_FontWeight" }, "size": { "format": "float", "type": "string" }, "color": { "$ref": "#/components/schemas/Color" }, "underline": { "type": "boolean" }, "strike": { "type": "boolean" }, "italic": { "type": "boolean" }, "font_name": { "$ref": "#/components/schemas/PortionStyle_FontName" } } }, "DatabaseTable_DatabaseColumn_SelectColumn": { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_ColumnOption" } } } }, "FieldMask": { "type": "object", "properties": { "paths": { "type": "array", "items": { "type": "string" } } } }, "Color_HexColor": { "type": "object", "properties": { "value": { "type": "string" } } }, "LayoutCamelCase": { "type": "object", "properties": { "rotate": { "format": "int32", "type": "string" }, "horizontalLayout": { "$ref": "#/components/schemas/Layout_FollowAutoLayoutTypeCamelCase" }, "verticalLayout": { "$ref": "#/components/schemas/Layout_FollowAutoLayoutTypeCamelCase" }, "top": { "format": "float", "type": "string" }, "left": { "format": "float", "type": "string" }, "width": { "format": "float", "type": "string" }, "flipv": { "type": "boolean" }, "fliph": { "type": "boolean" }, "constraints": { "$ref": "#/components/schemas/Layout_ConstraintsCamelCase" }, "height": { "format": "float", "type": "string" } } }, "MembershipCamelCase": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/Membership_ModeCamelCase" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseValueCamelCase" } } } }, "VaniGraphicObject": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "shape", "connector", "picture", "group_shape", "domain_diagram", "diagram", "structure", "table", "chart", "database_table", "sticky_note", "database_table_view" ], "name": "graphic_object_type" } ], "properties": { "shape": { "$ref": "#/components/schemas/VaniShape" }, "sticky_note": { "$ref": "#/components/schemas/VaniGraphicObject_StickyNote" }, "group_shape": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "database_table": { "$ref": "#/components/schemas/DatabaseTable" }, "picture": { "$ref": "#/components/schemas/Picture" }, "structure": { "$ref": "#/components/schemas/Structure" }, "domain_diagram": { "$ref": "#/components/schemas/DomainDiagram" }, "diagram": { "$ref": "#/components/schemas/Diagram" }, "connector": { "$ref": "#/components/schemas/Connector" }, "name": { "type": "string" }, "database_table_view": { "$ref": "#/components/schemas/DatabaseTableView" }, "id": { "type": "string" }, "chart": { "$ref": "#/components/schemas/Chart" }, "table": { "$ref": "#/components/schemas/Table" } } }, "Chart_LineSetting_DataMarker_DataMarkerTypeCamelCase": { "type": "string", "enum": [ "CIRCLE", "DASH", "DIAMOND", "DOT" ] }, "Shape_CalloutCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CalloutTypeCamelCase" } } }, "UMLKitSymbolCamelCase": { "type": "object", "properties": {} }, "Chart_ChartTitleCamelCase": { "type": "object", "properties": { "title": { "type": "string" } } }, "PictureFiltersCamelCase": { "type": "object", "properties": { "brightness": { "format": "float", "type": "string" }, "contrast": { "format": "float", "type": "string" }, "colorMode": { "$ref": "#/components/schemas/PictureFilters_ColorModeCamelCase" } } }, "Chart_LineSetting_DataMarkerCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Chart_LineSetting_DataMarker_DataMarkerTypeCamelCase" }, "fill": { "$ref": "#/components/schemas/FillCamelCase" }, "stroke": { "$ref": "#/components/schemas/StrokeCamelCase" } } }, "Comparison": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/ComparisonOp" }, "operand": { "$ref": "#/components/schemas/Operand" } } }, "ZoneSlotListCamelCase": { "type": "object", "properties": { "zoneSlots": { "type": "array", "items": { "$ref": "#/components/schemas/Zone_ZoneObjectSlotCamelCase" } } } }, "ColorCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "rgb", "hex", "hsb", "swatchId" ], "name": "color_type" } ], "properties": { "swatchId": { "type": "string" }, "hsb": { "$ref": "#/components/schemas/Color_HSBColorCamelCase" }, "hex": { "$ref": "#/components/schemas/Color_HexColorCamelCase" }, "rgb": { "$ref": "#/components/schemas/Color_RGBColorCamelCase" } } }, "DomainDiagram_DiagramLayout": { "type": "string", "enum": [ "LAYOUT_UNSPECIFIED", "TOP_DOWN", "LEFT_RIGHT" ] }, "Chart": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "table" ], "name": "data" }, { "members": [ "bar", "column", "line", "area", "pie", "scatter", "doughnut", "bubble" ], "name": "chart_type" } ], "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "area": { "$ref": "#/components/schemas/Chart_AreaChart" }, "bar": { "$ref": "#/components/schemas/Chart_BarChart" }, "bubble": { "$ref": "#/components/schemas/Chart_BubbleChart" }, "line": { "$ref": "#/components/schemas/Chart_LineChart" }, "scatter": { "$ref": "#/components/schemas/Chart_ScatterChart" }, "column": { "$ref": "#/components/schemas/Chart_BarChart" }, "axes": { "type": "array", "items": { "$ref": "#/components/schemas/Chart_ChartAxis" } }, "chart_title": { "$ref": "#/components/schemas/Chart_ChartTitle" }, "pie": { "$ref": "#/components/schemas/Chart_PieChart" }, "table": { "$ref": "#/components/schemas/Table" }, "doughnut": { "$ref": "#/components/schemas/Chart_DoughnutChart" } } }, "Chart_AreaChartCamelCase": { "type": "object", "properties": { "dropLines": { "$ref": "#/components/schemas/StrokeCamelCase" }, "grouping": { "$ref": "#/components/schemas/Chart_GroupingCamelCase" } } }, "Path": { "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/PathCommand" } } } }, "Shape_Basic_SnipRectangle_SnipRectangleType": { "type": "string", "enum": [ "SNIP_SINGLE", "SNIP_SAME_SIDE", "SNIP_DIAGONAL" ] }, "SpaceCamelCase": { "type": "object", "properties": { "specVersion": { "$ref": "#/components/schemas/SpecVersionCamelCase" }, "zoneIds": { "type": "array", "items": { "type": "string" } }, "manifest": { "$ref": "#/components/schemas/SpaceManifestCamelCase" }, "name": { "type": "string" }, "styleManifestId": { "type": "string" }, "id": { "type": "string" } } }, "ERDKitSymbol_EntityTable_ERDEntityTableColumnType": { "type": "string", "enum": [ "UNKNOWN_COLUMN_TYPE", "KEY", "FIELD", "TYPE" ] }, "DatabaseTableCamelCase": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumnCamelCase" } }, "name": { "type": "string" }, "id": { "type": "string" }, "viewConfig": { "$ref": "#/components/schemas/ViewConfigCamelCase" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseRowCamelCase" } } } }, "DatabaseTableView_KanbanFormCamelCase": { "type": "object", "properties": {} }, "Shape_Star_Wave_WaveTypeCamelCase": { "type": "string", "enum": [ "SINGLE", "DOUBLE" ] }, "ParaStyle_ListStyle_BulletType": { "type": "string", "enum": [ "NONE", "CHARACTER", "NUMBER" ] }, "Fill_NoFill": { "type": "object", "properties": {} }, "SmoothQuadraticTo": { "type": "object", "properties": { "end": { "$ref": "#/components/schemas/Point" } } }, "DatabaseTable_DatabaseColumn_CategoryColumn_Category": { "type": "object", "properties": { "name": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_ColumnOption" } }, "id": { "type": "string" } } }, "Layout": { "type": "object", "properties": { "rotate": { "format": "int32", "type": "string" }, "top": { "format": "float", "type": "string" }, "vertical_layout": { "$ref": "#/components/schemas/Layout_FollowAutoLayoutType" }, "left": { "format": "float", "type": "string" }, "width": { "format": "float", "type": "string" }, "flipv": { "type": "boolean" }, "fliph": { "type": "boolean" }, "constraints": { "$ref": "#/components/schemas/Layout_Constraints" }, "height": { "format": "float", "type": "string" }, "horizontal_layout": { "$ref": "#/components/schemas/Layout_FollowAutoLayoutType" } } }, "PictureFilters_ColorMode_GrayScaleCamelCase": { "type": "object", "properties": {} }, "AutoLayout_SpacingCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AutoLayout_Spacing_SpacingTypeCamelCase" }, "value": { "format": "float", "type": "string" } } }, "Placeholder_PlaceholderType": { "type": "string", "enum": [ "TITLE", "SUBTITLE", "CONTENT", "IMAGE", "CHART", "TABLE", "CALL_TO_ACTION", "LOGO" ] }, "PictureFilters_ColorMode_SepiaCamelCase": { "type": "object", "properties": {} }, "BoolOp": { "type": "string", "enum": [ "BOOL_OP_UNSPECIFIED", "AND", "OR" ] }, "Aggregate": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "common", "number", "date", "boolean", "text" ], "name": "fn" } ], "properties": { "date": { "$ref": "#/components/schemas/Aggregate_Date" }, "number": { "$ref": "#/components/schemas/Aggregate_Number" }, "boolean": { "$ref": "#/components/schemas/Aggregate_Boolean" }, "common": { "$ref": "#/components/schemas/Aggregate_Common" }, "text": { "$ref": "#/components/schemas/Aggregate_Text" } } }, "PlaceholderCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Placeholder_PlaceholderTypeCamelCase" } } }, "DeleteZoneOp": { "type": "object", "properties": { "zone_id": { "type": "string" } } }, "Color_RGBColorCamelCase": { "type": "object", "properties": { "red": { "format": "int32", "type": "string" }, "green": { "format": "int32", "type": "string" }, "blue": { "format": "int32", "type": "string" } } }, "InsertZoneOp": { "type": "object", "properties": { "insert_index": { "format": "int32", "type": "string" }, "zone": { "$ref": "#/components/schemas/Zone" } } }, "DomainDiagram_DfdDiagram": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramConnector" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DfdNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramEdge" } } } }, "PictureFilters_ColorModeCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "grayScale", "bilevel", "sepia", "duotone" ], "name": "mode" } ], "properties": { "grayScale": { "$ref": "#/components/schemas/PictureFilters_ColorMode_GrayScaleCamelCase" }, "sepia": { "$ref": "#/components/schemas/PictureFilters_ColorMode_SepiaCamelCase" }, "duotone": { "$ref": "#/components/schemas/PictureFilters_ColorMode_DuotoneCamelCase" }, "bilevel": { "$ref": "#/components/schemas/PictureFilters_ColorMode_BilevelCamelCase" } } }, "ChartCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "table" ], "name": "data" }, { "members": [ "bar", "column", "line", "area", "pie", "scatter", "doughnut", "bubble" ], "name": "chart_type" } ], "properties": { "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "area": { "$ref": "#/components/schemas/Chart_AreaChartCamelCase" }, "bar": { "$ref": "#/components/schemas/Chart_BarChartCamelCase" }, "bubble": { "$ref": "#/components/schemas/Chart_BubbleChartCamelCase" }, "chartTitle": { "$ref": "#/components/schemas/Chart_ChartTitleCamelCase" }, "line": { "$ref": "#/components/schemas/Chart_LineChartCamelCase" }, "scatter": { "$ref": "#/components/schemas/Chart_ScatterChartCamelCase" }, "column": { "$ref": "#/components/schemas/Chart_BarChartCamelCase" }, "axes": { "type": "array", "items": { "$ref": "#/components/schemas/Chart_ChartAxisCamelCase" } }, "pie": { "$ref": "#/components/schemas/Chart_PieChartCamelCase" }, "table": { "$ref": "#/components/schemas/TableCamelCase" }, "doughnut": { "$ref": "#/components/schemas/Chart_DoughnutChartCamelCase" } } }, "DomainDiagram_ErdDiagramCamelCase": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramConnectorCamelCase" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_ErdNodeCamelCase" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramEdgeCamelCase" } } } }, "InsetsCamelCase": { "type": "object", "properties": { "top": { "format": "float", "type": "string" }, "left": { "format": "float", "type": "string" }, "bottom": { "format": "float", "type": "string" }, "right": { "format": "float", "type": "string" } } }, "OperandCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "value", "column" ], "name": "operand" } ], "properties": { "column": { "$ref": "#/components/schemas/ColumnRefCamelCase" }, "value": { "$ref": "#/components/schemas/DatabaseValueCamelCase" } } }, "LibraryAssetRef": { "type": "object", "properties": { "library_id": { "type": "string" }, "asset_id": { "type": "string" } } }, "Shape_Star_WaveCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Wave_WaveTypeCamelCase" } } }, "Chart_ChartAxis_AxisCross": { "type": "object", "properties": { "with_axis_id": { "type": "string" }, "cross_at": { "$ref": "#/components/schemas/Chart_ChartAxis_AxisCross_CrossAt" } } }, "Chart_ChartAxis_ValueAxisCamelCase": { "type": "object", "properties": {} }, "ZoneCamelCase": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ZoneMetaCamelCase" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/Zone_ZoneObjectSlotCamelCase" } } } }, "Chart_DoughnutChartCamelCase": { "type": "object", "properties": { "explosion": { "format": "float", "type": "string" }, "firstSliceAngle": { "format": "float", "type": "string" }, "holeSize": { "format": "float", "type": "string" } } }, "ConditionCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "comparison", "textMatch", "membership", "between", "emptiness" ], "name": "test" } ], "properties": { "comparison": { "$ref": "#/components/schemas/ComparisonCamelCase" }, "emptiness": { "$ref": "#/components/schemas/EmptinessCamelCase" }, "column": { "$ref": "#/components/schemas/ColumnRefCamelCase" }, "textMatch": { "$ref": "#/components/schemas/TextMatchCamelCase" }, "membership": { "$ref": "#/components/schemas/MembershipCamelCase" }, "between": { "$ref": "#/components/schemas/BetweenCamelCase" } } }, "Shape_BlockArrow_DoubleArrow_DoubleArrowTypeCamelCase": { "type": "string", "enum": [ "UP_DOWN", "LEFT_RIGHT", "LEFT_UP" ] }, "Text_Paragraph": { "type": "object", "properties": { "style": { "$ref": "#/components/schemas/ParaStyle" }, "id": { "type": "string" }, "portions": { "type": "array", "items": { "$ref": "#/components/schemas/Text_Paragraph_Portion" } } } }, "Chart_BubbleChart": { "type": "object", "properties": { "bubble_size": { "$ref": "#/components/schemas/Chart_BubbleChart_BubbleSize" } } }, "Membership_ModeCamelCase": { "type": "string", "enum": [ "MODE_UNSPECIFIED", "HAS_ANY", "HAS_ALL", "HAS_NONE" ] }, "SortCamelCase": { "type": "object", "properties": { "column": { "$ref": "#/components/schemas/ColumnRefCamelCase" }, "order": { "$ref": "#/components/schemas/SortOrderCamelCase" } } }, "Color": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "rgb", "hex", "hsb", "swatch_id" ], "name": "color_type" } ], "properties": { "swatch_id": { "type": "string" }, "hsb": { "$ref": "#/components/schemas/Color_HSBColor" }, "hex": { "$ref": "#/components/schemas/Color_HexColor" }, "rgb": { "$ref": "#/components/schemas/Color_RGBColor" } } }, "VaniGraphicObject_StickyNoteCamelCase": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "type": { "$ref": "#/components/schemas/VaniGraphicObject_StickyNote_StickyNoteTypeCamelCase" } } }, "ReflectionCamelCase": { "type": "object", "properties": { "distance": { "format": "float", "type": "string" }, "alphaEnd": { "format": "float", "type": "string" }, "alphaStart": { "format": "float", "type": "string" }, "positionStart": { "format": "float", "type": "string" }, "positionEnd": { "format": "float", "type": "string" } } }, "ShapeCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "basic", "blockArrow", "flowchart", "mathematicalSymbol", "star", "callout", "custom" ], "name": "shape_type" } ], "properties": { "callout": { "$ref": "#/components/schemas/Shape_CalloutCamelCase" }, "star": { "$ref": "#/components/schemas/Shape_StarCamelCase" }, "custom": { "$ref": "#/components/schemas/CustomShapeCamelCase" }, "mathematicalSymbol": { "$ref": "#/components/schemas/Shape_MathematicalSymbolCamelCase" }, "blockArrow": { "$ref": "#/components/schemas/Shape_BlockArrowCamelCase" }, "flowchart": { "$ref": "#/components/schemas/Shape_FlowchartCamelCase" }, "text": { "$ref": "#/components/schemas/TextCamelCase" }, "basic": { "$ref": "#/components/schemas/Shape_BasicCamelCase" }, "properties": { "$ref": "#/components/schemas/GraphicObjectPropertiesCamelCase" } } }, "Layout_Constraints": { "type": "object", "properties": { "horizontal": { "$ref": "#/components/schemas/Layout_Constraints_HorizontalConstraint" }, "vertical": { "$ref": "#/components/schemas/Layout_Constraints_VerticalConstraint" } } }, "ClosePath": { "type": "object", "properties": {} }, "Shape_Star_Ribbon": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Ribbon_RibbonType" } } }, "Chart_ChartAxis_AxisCrossCamelCase": { "type": "object", "properties": { "crossAt": { "$ref": "#/components/schemas/Chart_ChartAxis_AxisCross_CrossAtCamelCase" }, "withAxisId": { "type": "string" } } }, "Structure_Mindmap_TopDownGroupShape": { "type": "object", "properties": { "top": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "bottom": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" } } }, "IndexPath": { "type": "object", "properties": { "indices": { "type": "array", "items": { "format": "int32", "type": "string" } } } }, "DatabaseTable_DatabaseColumn_RelationColumnCamelCase": { "type": "object", "properties": { "allowMultiple": { "type": "boolean" }, "relatedTableId": { "type": "string" }, "reciprocalColumnId": { "type": "string" } } }, "Shape_Star_Point": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Point_StarPointType" } } }, "Connector": { "type": "object", "properties": { "connected": { "$ref": "#/components/schemas/Connector_ConnectedShape" }, "text": { "$ref": "#/components/schemas/Text" }, "type": { "$ref": "#/components/schemas/Connector_ConnectorType" }, "stroke": { "$ref": "#/components/schemas/Stroke" } } }, "Fill_SolidFill": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/Color" } } }, "DataUpdateSpaceRequest": { "type": "object", "properties": { "base_revision_id": { "description": "Optimistic-concurrency revision token", "type": "string" }, "space_id": { "description": "Target space identifier (echoed from URL path; optional in body)", "type": "string" }, "operation": { "contentSchema": { "$ref": "#/components/schemas/SpaceOperation" }, "x-vani-schema": { "$ref": "#/components/schemas/SpaceOperation" }, "contentMediaType": "application/json", "description": "Stringified JSON of a single SpaceOperation proto: {operation_id?, and exactly one of update_space_meta | insert_zone | update_zone_meta | delete_zone | insert_frame | update_frame_meta | delete_frame | insert_zone_slot | update_zone_slot | delete_zone_slot | insert_object | update_object | delete_object | update_object_facet}", "x-vani-stringified": true, "type": "string", "maxLength": 500000 } }, "required": [ "operation" ] }, "ListOperationKindCamelCase": { "type": "string", "enum": [ "LIST_OPERATION_KIND_UNSPECIFIED", "LIST_OPERATION_KIND_ZONES", "LIST_OPERATION_KIND_FRAMES", "LIST_OPERATION_KIND_ZONE_SLOTS", "LIST_OPERATION_KIND_OBJECTS" ] }, "ObjectContainerRef": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "zone", "frame" ], "name": "container" } ], "properties": { "zone": { "$ref": "#/components/schemas/ZoneContainerRef" }, "frame": { "$ref": "#/components/schemas/FrameContainerRef" } } }, "Chart_PieChart_RepresentativePieCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "position", "percentValue", "value" ], "name": "split_data" } ], "properties": { "percentValue": { "format": "float", "type": "string" }, "size": { "format": "int32", "type": "string" }, "position": { "format": "int32", "type": "string" }, "type": { "$ref": "#/components/schemas/Chart_PieChart_RepresentativePie_RepresentativePieTypeCamelCase" }, "value": { "format": "float", "type": "string" } } }, "Shape_Star_Ribbon_RibbonType": { "type": "string", "enum": [ "UP", "DOWN", "CURVED_UP", "CURVED_DOWN" ] }, "ERDKitSymbol_Relationship": { "type": "object", "properties": { "start": { "$ref": "#/components/schemas/ERDKitSymbol_Cardinality" }, "end": { "$ref": "#/components/schemas/ERDKitSymbol_Cardinality" } } }, "EmptinessCamelCase": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/EmptinessOpCamelCase" } } }, "MathematicalSymbolTypeCamelCase": { "type": "string", "enum": [ "MATHEMATICAL_SYMBOL_TYPE_UNSPECIFIED", "PLUS", "MINUS", "MULTIPLY", "DIVIDE", "EQUAL", "NOT_EQUAL" ] }, "Fill_GradientFill_StopCamelCase": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/ColorCamelCase" }, "position": { "format": "float", "type": "string" } } }, "DFDKitSymbol_DFDNotationCamelCase": { "type": "string", "enum": [ "UNKNOWN_DFD", "YOURDON_AND_COAD", "GANE_AND_SARSON" ] }, "ParaStyle_ListStyle_CharacterBulletCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ParaStyle_ListStyle_CharacterBullet_CharacterBulletTypeCamelCase" } } }, "DeleteFrameOp": { "type": "object", "properties": { "zone_id": { "type": "string" }, "frame_id": { "type": "string" } } }, "Fill_PictureFill_PictureFillTypeCamelCase": { "type": "string", "enum": [ "SCALE", "TILE" ] }, "Condition": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "comparison", "text_match", "membership", "between", "emptiness" ], "name": "test" } ], "properties": { "text_match": { "$ref": "#/components/schemas/TextMatch" }, "comparison": { "$ref": "#/components/schemas/Comparison" }, "emptiness": { "$ref": "#/components/schemas/Emptiness" }, "column": { "$ref": "#/components/schemas/ColumnRef" }, "membership": { "$ref": "#/components/schemas/Membership" }, "between": { "$ref": "#/components/schemas/Between" } } }, "Aggregate_TextCamelCase": { "type": "string", "enum": [ "TEXT_UNSPECIFIED", "CONCAT", "CONCAT_UNIQUE" ] }, "Shape_Basic_Bracket": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_Bracket_BracketType" } } }, "Table_CellBorderCamelCase": { "type": "object", "properties": { "all": { "$ref": "#/components/schemas/StrokeCamelCase" }, "top": { "$ref": "#/components/schemas/StrokeCamelCase" }, "left": { "$ref": "#/components/schemas/StrokeCamelCase" }, "bottom": { "$ref": "#/components/schemas/StrokeCamelCase" }, "right": { "$ref": "#/components/schemas/StrokeCamelCase" } } }, "TextMatch": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/TextMatchOp" }, "case_sensitive": { "type": "boolean" }, "text": { "type": "string" } } }, "Stroke_JoinType": { "type": "string", "enum": [ "ROUND", "BEVEL", "MITER" ] }, "Aggregate_Boolean": { "type": "string", "enum": [ "BOOLEAN_UNSPECIFIED", "CHECKED", "UNCHECKED", "PERCENT_CHECKED", "PERCENT_UNCHECKED" ] }, "ParaStyle_ListStyle_CharacterBullet": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ParaStyle_ListStyle_CharacterBullet_CharacterBulletType" } } }, "Shape_BlockArrow_ArrowCallout": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowType" } } }, "Chart_ChartAxis_AxisCross_CrossAtCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "autoCross", "value" ], "name": "ref" } ], "properties": { "autoCross": { "$ref": "#/components/schemas/Chart_ChartAxis_AxisCross_CrossAt_AutoCrossCamelCase" }, "value": { "format": "float", "type": "string" } } }, "DatabaseTable_DatabaseColumn_RollupColumn": { "type": "object", "properties": { "source_column_id": { "type": "string" }, "relation_column_id": { "type": "string" }, "aggregate": { "$ref": "#/components/schemas/Aggregate" } } }, "Chart_ChartAxis_PositionElementCamelCase": { "type": "string", "enum": [ "TOP", "LEFT", "BOTTOM", "RIGHT", "CENTER" ] }, "FlowchartType": { "type": "string", "enum": [ "FLOWCHART_TYPE_UNSPECIFIED", "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" ] }, "Shape_Basic": { "type": "object", "properties": { "snip_rectangle": { "$ref": "#/components/schemas/Shape_Basic_SnipRectangle" }, "rounded_rectangle": { "$ref": "#/components/schemas/Shape_Basic_RoundedRectangle" }, "bracket": { "$ref": "#/components/schemas/Shape_Basic_Bracket" }, "brace": { "$ref": "#/components/schemas/Shape_Basic_Bracket" }, "type": { "$ref": "#/components/schemas/BasicShapeType" }, "triangle": { "$ref": "#/components/schemas/Shape_Basic_Triangle" } } }, "ERDKitSymbol_CardinalityCamelCase": { "type": "string", "enum": [ "UNKNOWN_CARDINALITY", "ONE", "MANY", "ONE_MANDATORY", "ZERO_OR_ONE", "ONE_OR_MANY", "ZERO_OR_MANY" ] }, "Layout_ConstraintsCamelCase": { "type": "object", "properties": { "horizontal": { "$ref": "#/components/schemas/Layout_Constraints_HorizontalConstraintCamelCase" }, "vertical": { "$ref": "#/components/schemas/Layout_Constraints_VerticalConstraintCamelCase" } } }, "TextCamelCase": { "type": "object", "properties": { "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/Text_ParagraphCamelCase" } }, "properties": { "$ref": "#/components/schemas/TextPropertiesCamelCase" } } }, "DatabaseTableViewCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "grid", "kanban" ], "name": "form" } ], "properties": { "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "grid": { "$ref": "#/components/schemas/DatabaseTableView_GridFormCamelCase" }, "kanban": { "$ref": "#/components/schemas/DatabaseTableView_KanbanFormCamelCase" }, "name": { "type": "string" }, "tableId": { "type": "string" }, "id": { "type": "string" }, "viewConfig": { "$ref": "#/components/schemas/ViewConfigCamelCase" } } }, "Structure_Mindmap_TopDownGroupShapeCamelCase": { "type": "object", "properties": { "top": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "bottom": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" } } }, "DatabaseTable_DatabaseColumn_LookupColumnCamelCase": { "type": "object", "properties": { "relationColumnId": { "type": "string" }, "sourceColumnId": { "type": "string" } } }, "Emptiness": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/EmptinessOp" } } }, "Structure_KanbanCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "horizontal", "vertical" ], "name": "kanban_layout" } ], "properties": { "container": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "horizontal": { "$ref": "#/components/schemas/Structure_Kanban_HorizontalKanbanCamelCase" }, "vertical": { "$ref": "#/components/schemas/Structure_Kanban_VerticalKanbanCamelCase" }, "tableViewId": { "type": "string" } } }, "ERDKitSymbol_RelationshipCamelCase": { "type": "object", "properties": { "start": { "$ref": "#/components/schemas/ERDKitSymbol_CardinalityCamelCase" }, "end": { "$ref": "#/components/schemas/ERDKitSymbol_CardinalityCamelCase" } } }, "Fill_GradientFill": { "type": "object", "properties": { "linear": { "$ref": "#/components/schemas/Fill_GradientFill_LinearGeometry" }, "radial_angular": { "$ref": "#/components/schemas/Fill_GradientFill_RadialAngularGeometry" }, "stops": { "type": "array", "items": { "$ref": "#/components/schemas/Fill_GradientFill_Stop" } }, "type": { "$ref": "#/components/schemas/Fill_GradientFill_GradientFillType" } } }, "Layout_Constraints_HorizontalConstraint": { "type": "string", "enum": [ "LEFT", "RIGHT", "CENTER", "LEFT_RIGHT", "HORIZONTAL_SCALE" ] }, "Membership": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/Membership_Mode" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseValue" } } } }, "BlockArrowType": { "type": "string", "enum": [ "BLOCK_ARROW_TYPE_UNSPECIFIED", "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" ] }, "Shape_MathematicalSymbolCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MathematicalSymbolTypeCamelCase" } } }, "DomainDiagramCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "uml", "dfd", "erd" ], "name": "diagram_type" } ], "properties": { "layout": { "$ref": "#/components/schemas/DomainDiagram_DiagramLayoutCamelCase" }, "dfd": { "$ref": "#/components/schemas/DomainDiagram_DfdDiagramCamelCase" }, "uml": { "$ref": "#/components/schemas/DomainDiagram_UmlDiagramCamelCase" }, "erd": { "$ref": "#/components/schemas/DomainDiagram_ErdDiagramCamelCase" }, "type": { "$ref": "#/components/schemas/DomainDiagram_DiagramTypeCamelCase" } } }, "Chart_ChartAxis_ValueAxis": { "type": "object", "properties": {} }, "DomainDiagram_UmlDiagramCamelCase": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramConnectorCamelCase" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_UmlNodeCamelCase" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramEdgeCamelCase" } } } }, "ResourceRefCamelCase": { "type": "object", "properties": { "id": { "type": "string" }, "uri": { "type": "string" }, "contentType": { "type": "string" } } }, "PathCamelCase": { "type": "object", "properties": { "commands": { "type": "array", "items": { "$ref": "#/components/schemas/PathCommandCamelCase" } } } }, "Shape_Star_Scroll_ScrollTypeCamelCase": { "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "DatabaseTable_DatabaseColumn_RelationColumn": { "type": "object", "properties": { "reciprocal_column_id": { "type": "string" }, "allow_multiple": { "type": "boolean" }, "related_table_id": { "type": "string" } } }, "Reflection": { "type": "object", "properties": { "alpha_start": { "format": "float", "type": "string" }, "distance": { "format": "float", "type": "string" }, "alpha_end": { "format": "float", "type": "string" }, "position_end": { "format": "float", "type": "string" }, "position_start": { "format": "float", "type": "string" } } }, "MoveToCamelCase": { "type": "object", "properties": { "point": { "$ref": "#/components/schemas/PointCamelCase" } } }, "DatabaseValue_MultiSelect": { "type": "object", "properties": { "option_ids": { "type": "array", "items": { "type": "string" } } } }, "DatabaseTable_DatabaseRow_DatabaseCell": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "$ref": "#/components/schemas/DatabaseValue" } } }, "Shape_Basic_RoundedRectangle": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_RoundedRectangle_RoundedRectangleType" } } }, "Shape_Basic_Bracket_BracketTypeCamelCase": { "type": "string", "enum": [ "DOUBLE", "RIGHT", "LEFT" ] }, "Shape_Basic_RoundedRectangleCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_RoundedRectangle_RoundedRectangleTypeCamelCase" } } }, "EmptinessOp": { "type": "string", "enum": [ "EMPTINESS_OP_UNSPECIFIED", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "Frame": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/FrameMeta" }, "graphic_objects": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObject" } }, "type": { "$ref": "#/components/schemas/FrameType" }, "properties": { "$ref": "#/components/schemas/GraphicObjectProperties" }, "frame_id": { "type": "string" } } }, "Zone_ZoneObjectSlot": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "frame_id", "graphic_object" ], "name": "object" } ], "properties": { "graphic_object": { "$ref": "#/components/schemas/VaniGraphicObject" }, "frame_id": { "type": "string" } } }, "ERDKitSymbolCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "entityTable", "relationship" ], "name": "component_details" } ], "properties": { "entityTable": { "$ref": "#/components/schemas/ERDKitSymbol_EntityTableCamelCase" }, "relationship": { "$ref": "#/components/schemas/ERDKitSymbol_RelationshipCamelCase" } } }, "Shape_Flowchart": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowchartType" } } }, "GetOperationKindCamelCase": { "type": "string", "enum": [ "GET_OPERATION_KIND_UNSPECIFIED", "GET_OPERATION_KIND_SPACE", "GET_OPERATION_KIND_ZONE", "GET_OPERATION_KIND_FRAME", "GET_OPERATION_KIND_ZONE_SLOT", "GET_OPERATION_KIND_OBJECT", "GET_OPERATION_KIND_OBJECT_FACET" ] }, "Structure_Spacing": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Structure_Spacing_SpacingType" }, "manual": { "format": "float", "type": "string" } } }, "Shape_BlockArrow_SingleArrow": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowType" } } }, "AutoLayout_Spacing": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AutoLayout_Spacing_SpacingType" }, "value": { "format": "float", "type": "string" } } }, "DatabaseTable_DatabaseColumn_ColumnOptionCamelCase": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/ColorCamelCase" }, "id": { "type": "string" }, "value": { "type": "string" } } }, "DatabaseTable": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn" } }, "name": { "type": "string" }, "view_config": { "$ref": "#/components/schemas/ViewConfig" }, "id": { "type": "string" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseRow" } } } }, "DatabaseTableView_GridForm": { "type": "object", "properties": {} }, "Structure": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "stack", "kanban", "mindmap" ], "name": "structure_type" } ], "properties": { "stack": { "$ref": "#/components/schemas/Structure_Stack" }, "kanban": { "$ref": "#/components/schemas/Structure_Kanban" }, "mindmap": { "$ref": "#/components/schemas/Structure_Mindmap" }, "title": { "type": "string" } } }, "GraphicObjectPropertiesCamelCase": { "type": "object", "properties": { "strokeStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "strokes": { "type": "array", "items": { "$ref": "#/components/schemas/StrokeCamelCase" } }, "shadow": { "$ref": "#/components/schemas/ShadowCamelCase" }, "reflection": { "$ref": "#/components/schemas/ReflectionCamelCase" }, "imageStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "spacingStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "regionId": { "type": "string" }, "dataBinding": { "type": "string" }, "fillStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "effectStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "placeholder": { "$ref": "#/components/schemas/PlaceholderCamelCase" }, "fills": { "type": "array", "items": { "$ref": "#/components/schemas/FillCamelCase" } }, "layerStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" } } }, "Stroke_StrokePositionCamelCase": { "type": "string", "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "Chart_BubbleChart_BubbleSize": { "type": "object", "properties": { "scale": { "format": "float", "type": "string" }, "represent": { "$ref": "#/components/schemas/Chart_BubbleChart_BubbleSize_RepresentBubbleSize" } } }, "AutoLayout_GridCamelCase": { "type": "object", "properties": { "columnWidths": { "type": "array", "items": { "format": "float", "type": "string" } }, "rowHeights": { "type": "array", "items": { "format": "float", "type": "string" } } } }, "Aggregate_Common": { "type": "string", "enum": [ "COMMON_UNSPECIFIED", "COUNT", "COUNT_EMPTY", "COUNT_NOT_EMPTY", "COUNT_UNIQUE", "PERCENT_EMPTY", "PERCENT_NOT_EMPTY" ] }, "Text": { "type": "object", "properties": { "paragraphs": { "type": "array", "items": { "$ref": "#/components/schemas/Text_Paragraph" } }, "properties": { "$ref": "#/components/schemas/TextProperties" } } }, "ParaStyle_ListStyle_NumberBullet": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ParaStyle_ListStyle_NumberBullet_NumberBulletType" }, "startat": { "format": "int32", "type": "string" } } }, "Diagram": { "type": "object", "properties": {} }, "Fill_SolidFillCamelCase": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/ColorCamelCase" } } }, "Chart_DoughnutChart": { "type": "object", "properties": { "explosion": { "format": "float", "type": "string" }, "first_slice_angle": { "format": "float", "type": "string" }, "hole_size": { "format": "float", "type": "string" } } }, "DatabaseTable_DatabaseColumnCamelCase": { "type": "object", "properties": { "lookupColumn": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_LookupColumnCamelCase" }, "defaultValue": { "$ref": "#/components/schemas/DatabaseValueCamelCase" }, "unique": { "type": "boolean" }, "name": { "type": "string" }, "rollupColumn": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_RollupColumnCamelCase" }, "relationColumn": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_RelationColumnCamelCase" }, "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/DatabaseTable_ColumnTypeCamelCase" }, "selectColumn": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_SelectColumnCamelCase" }, "categoryColumn": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_CategoryColumnCamelCase" }, "required": { "type": "boolean" } } }, "Table_TableRow_TableCellCamelCase": { "type": "object", "properties": { "border": { "$ref": "#/components/schemas/Table_CellBorderCamelCase" }, "isMerged": { "type": "boolean" }, "mergeRows": { "format": "int32", "type": "string" }, "mergeCols": { "format": "int32", "type": "string" }, "id": { "type": "string" }, "text": { "$ref": "#/components/schemas/TextCamelCase" }, "fill": { "$ref": "#/components/schemas/FillCamelCase" } } }, "Connector_ConnectorTypeCamelCase": { "type": "string", "enum": [ "LINE", "ELBOW", "CURVE" ] }, "UMLKitSymbol": { "type": "object", "properties": {} }, "UpdateSpaceMetaOp": { "type": "object", "properties": { "update_mask": { "$ref": "#/components/schemas/FieldMask" }, "space": { "$ref": "#/components/schemas/Space" } } }, "PortionStyleCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "fontName", "fontId" ], "name": "font" } ], "properties": { "fontName": { "$ref": "#/components/schemas/PortionStyle_FontNameCamelCase" }, "fontweight": { "$ref": "#/components/schemas/PortionStyle_FontWeightCamelCase" }, "size": { "format": "float", "type": "string" }, "fontId": { "type": "string" }, "color": { "$ref": "#/components/schemas/ColorCamelCase" }, "underline": { "type": "boolean" }, "strike": { "type": "boolean" }, "italic": { "type": "boolean" } } }, "ResourceRef": { "type": "object", "properties": { "content_type": { "type": "string" }, "id": { "type": "string" }, "uri": { "type": "string" } } }, "Shape_Basic_TriangleCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_Triangle_TriangleTypeCamelCase" } } }, "PortionStyle_FontWeightCamelCase": { "type": "string", "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "Fill": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "no_fill", "solid", "gradient", "picture" ], "name": "fill_type" } ], "properties": { "no_fill": { "$ref": "#/components/schemas/Fill_NoFill" }, "solid": { "$ref": "#/components/schemas/Fill_SolidFill" }, "gradient": { "$ref": "#/components/schemas/Fill_GradientFill" }, "alpha": { "format": "float", "type": "string" }, "picture": { "$ref": "#/components/schemas/Fill_PictureFill" } } }, "DomainDiagram_DiagramConnector": { "type": "object", "properties": { "connector": { "$ref": "#/components/schemas/Connector" }, "id": { "type": "string" } } }, "KitShape_BaseKitTypeCamelCase": { "type": "string", "enum": [ "UML", "DFD", "ERD" ] }, "Shape_Star_Ribbon_RibbonTypeCamelCase": { "type": "string", "enum": [ "UP", "DOWN", "CURVED_UP", "CURVED_DOWN" ] }, "Chart_BarChartCamelCase": { "type": "object", "properties": { "overlap": { "format": "float", "type": "string" }, "gap": { "format": "float", "type": "string" }, "grouping": { "$ref": "#/components/schemas/Chart_GroupingCamelCase" }, "seriesLine": { "$ref": "#/components/schemas/StrokeCamelCase" } } }, "DataBatchUpdateSpaceRequest": { "type": "object", "properties": { "operations": { "minItems": 1, "maxItems": 100, "description": "Array of SpaceOperation proto JSON objects", "type": "array", "items": { "contentSchema": { "$ref": "#/components/schemas/SpaceOperation" }, "x-vani-schema": { "$ref": "#/components/schemas/SpaceOperation" }, "contentMediaType": "application/json", "x-vani-stringified": true, "type": "string", "maxLength": 5000000 } }, "apply_mode": { "default": "BEST_EFFORT", "description": "Batch execution strategy; defaults to BEST_EFFORT when omitted", "type": "string", "maxLength": 50, "enum": [ "BATCH_APPLY_MODE_UNSPECIFIED", "ATOMIC", "BEST_EFFORT" ] }, "base_revision_id": { "description": "Optimistic-concurrency revision token", "type": "string" }, "space_id": { "description": "Target space identifier (echoed from URL path; optional in body)", "type": "string" } }, "required": [ "operations" ] }, "Shape_Star_RibbonCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Ribbon_RibbonTypeCamelCase" } } }, "ERDKitSymbol_EntityTable": { "type": "object", "properties": { "column_types": { "type": "array", "items": { "$ref": "#/components/schemas/ERDKitSymbol_EntityTable_ERDEntityTableColumnType" } } } }, "FrameListCamelCase": { "type": "object", "properties": { "frames": { "type": "array", "items": { "$ref": "#/components/schemas/FrameCamelCase" } } } }, "ZoneMeta": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "Sort": { "type": "object", "properties": { "column": { "$ref": "#/components/schemas/ColumnRef" }, "order": { "$ref": "#/components/schemas/SortOrder" } } }, "Chart_PieChartCamelCase": { "type": "object", "properties": { "explosion": { "format": "float", "type": "string" }, "representativePie": { "$ref": "#/components/schemas/Chart_PieChart_RepresentativePieCamelCase" }, "firstSliceAngle": { "format": "float", "type": "string" } } }, "BasicShapeType": { "type": "string", "enum": [ "BASIC_SHAPE_TYPE_UNSPECIFIED", "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" ] }, "ParaStyle_ListStyle_NumberBullet_NumberBulletType": { "type": "string", "enum": [ "NUMERIC_DOT", "NUMERIC_BRACKET", "UCROMAN_DOT", "LCROMAN_DOT", "UCALPHABET_DOT", "LC_ALPHABET_DOT" ] }, "Shape_Star_Wave_WaveType": { "type": "string", "enum": [ "SINGLE", "DOUBLE" ] }, "SpaceOperation": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "update_space_meta", "insert_zone", "update_zone_meta", "delete_zone", "insert_frame", "update_frame_meta", "delete_frame", "insert_zone_slot", "update_zone_slot", "delete_zone_slot", "insert_object", "update_object", "delete_object", "update_object_facet" ], "name": "op" } ], "properties": { "insert_frame": { "$ref": "#/components/schemas/InsertFrameOp" }, "update_space_meta": { "$ref": "#/components/schemas/UpdateSpaceMetaOp" }, "delete_zone_slot": { "$ref": "#/components/schemas/DeleteZoneSlotOp" }, "delete_zone": { "$ref": "#/components/schemas/DeleteZoneOp" }, "insert_zone_slot": { "$ref": "#/components/schemas/InsertZoneSlotOp" }, "update_object_facet": { "$ref": "#/components/schemas/UpdateObjectFacetOp" }, "insert_zone": { "$ref": "#/components/schemas/InsertZoneOp" }, "update_frame_meta": { "$ref": "#/components/schemas/UpdateFrameMetaOp" }, "delete_object": { "$ref": "#/components/schemas/DeleteObjectOp" }, "update_object": { "$ref": "#/components/schemas/UpdateObjectOp" }, "update_zone_slot": { "$ref": "#/components/schemas/UpdateZoneSlotOp" }, "operation_id": { "type": "string" }, "update_zone_meta": { "$ref": "#/components/schemas/UpdateZoneMetaOp" }, "delete_frame": { "$ref": "#/components/schemas/DeleteFrameOp" }, "insert_object": { "$ref": "#/components/schemas/InsertObjectOp" } } }, "ParaStyle_ListStyle_BulletTypeCamelCase": { "type": "string", "enum": [ "NONE", "CHARACTER", "NUMBER" ] }, "Shape_BlockArrow_ArrowCalloutCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowTypeCamelCase" } } }, "DomainDiagram_DfdNode": { "type": "object", "properties": { "dfd": { "$ref": "#/components/schemas/DFDKitSymbol" }, "id": { "type": "string" } } }, "Between": { "type": "object", "properties": { "high": { "$ref": "#/components/schemas/DatabaseValue" }, "low": { "$ref": "#/components/schemas/DatabaseValue" } } }, "DomainDiagram_DfdNodeCamelCase": { "type": "object", "properties": { "dfd": { "$ref": "#/components/schemas/DFDKitSymbolCamelCase" }, "id": { "type": "string" } } }, "Fill_GradientFill_RadialAngularGeometry": { "type": "object", "properties": { "flip_horizontal": { "type": "boolean" }, "center": { "$ref": "#/components/schemas/Point" }, "spread_x": { "format": "float", "type": "string" }, "spread_y": { "format": "float", "type": "string" }, "rotation_angle": { "format": "float", "type": "string" }, "flip_vertical": { "type": "boolean" } } }, "Structure_Kanban_VerticalKanban": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/Structure_Spacing" }, "stacks": { "type": "array", "items": { "$ref": "#/components/schemas/Structure_StackGroup" } } } }, "Text_Paragraph_PortionCamelCase": { "type": "object", "properties": { "style": { "$ref": "#/components/schemas/PortionStyleCamelCase" }, "text": { "type": "string" } } }, "ZoneListCamelCase": { "type": "object", "properties": { "zones": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneCamelCase" } } } }, "Chart_ScatterChart": { "type": "object", "properties": { "line": { "type": "boolean" }, "line_settings": { "$ref": "#/components/schemas/Chart_LineSetting" } } }, "TextProperties_TextBoxAutoFitCamelCase": { "type": "string", "enum": [ "NONE", "TEXT", "SHAPE" ] }, "Aggregate_NumberCamelCase": { "type": "string", "enum": [ "NUMBER_UNSPECIFIED", "SUM", "AVG", "MIN", "MAX", "MEDIAN", "RANGE" ] }, "AutoLayout_Grid": { "type": "object", "properties": { "column_widths": { "type": "array", "items": { "format": "float", "type": "string" } }, "row_heights": { "type": "array", "items": { "format": "float", "type": "string" } } } }, "ParaStyle_SpacingCamelCase": { "type": "object", "properties": { "before": { "format": "int32", "type": "string" }, "line": { "format": "float", "type": "string" }, "after": { "format": "int32", "type": "string" } } }, "AggregateCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "common", "number", "date", "boolean", "text" ], "name": "fn" } ], "properties": { "date": { "$ref": "#/components/schemas/Aggregate_DateCamelCase" }, "number": { "$ref": "#/components/schemas/Aggregate_NumberCamelCase" }, "boolean": { "$ref": "#/components/schemas/Aggregate_BooleanCamelCase" }, "common": { "$ref": "#/components/schemas/Aggregate_CommonCamelCase" }, "text": { "$ref": "#/components/schemas/Aggregate_TextCamelCase" } } }, "SpecVersionCamelCase": { "type": "object", "properties": { "patch": { "format": "int32", "type": "string" }, "major": { "format": "int32", "type": "string" }, "minor": { "format": "int32", "type": "string" } } }, "Chart_BarChart": { "type": "object", "properties": { "overlap": { "format": "float", "type": "string" }, "series_line": { "$ref": "#/components/schemas/Stroke" }, "gap": { "format": "float", "type": "string" }, "grouping": { "$ref": "#/components/schemas/Chart_Grouping" } } }, "Shape_Star_ScrollCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Scroll_ScrollTypeCamelCase" } } }, "Insets": { "type": "object", "properties": { "top": { "format": "float", "type": "string" }, "left": { "format": "float", "type": "string" }, "bottom": { "format": "float", "type": "string" }, "right": { "format": "float", "type": "string" } } }, "DatabaseTable_DatabaseColumn": { "type": "object", "properties": { "relation_column": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_RelationColumn" }, "rollup_column": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_RollupColumn" }, "unique": { "type": "boolean" }, "name": { "type": "string" }, "lookup_column": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_LookupColumn" }, "default_value": { "$ref": "#/components/schemas/DatabaseValue" }, "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/DatabaseTable_ColumnType" }, "select_column": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_SelectColumn" }, "category_column": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_CategoryColumn" }, "required": { "type": "boolean" } } }, "DomainDiagram_DiagramEdgeCamelCase": { "type": "object", "properties": { "connectorId": { "type": "string" }, "toNodeId": { "type": "string" }, "fromNodeId": { "type": "string" } } }, "Chart_ChartAxis_AxisCross_CrossAt": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "auto_cross", "value" ], "name": "ref" } ], "properties": { "auto_cross": { "$ref": "#/components/schemas/Chart_ChartAxis_AxisCross_CrossAt_AutoCross" }, "value": { "format": "float", "type": "string" } } }, "ViewConfigCamelCase": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/FilterCamelCase" }, "groupByColumnId": { "type": "string" }, "visibleColumnIds": { "type": "array", "items": { "type": "string" } }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/SortCamelCase" } } } }, "Shape_Basic_RoundedRectangle_RoundedRectangleTypeCamelCase": { "type": "string", "enum": [ "NORMAL", "SINGLE", "SAME_SIDE", "DIAGONAL" ] }, "HorizontalAlignTypeCamelCase": { "type": "string", "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] }, "ArcToCamelCase": { "type": "object", "properties": { "startAngle": { "format": "float", "type": "string" }, "xRadius": { "format": "float", "type": "string" }, "sweepAngle": { "format": "float", "type": "string" }, "end": { "$ref": "#/components/schemas/PointCamelCase" }, "yRadius": { "format": "float", "type": "string" } } }, "FrameType": { "type": "string", "enum": [ "FRAME_TYPE_UNSPECIFIED", "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" ] }, "Structure_Kanban_HorizontalKanbanCamelCase": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/Structure_SpacingCamelCase" }, "stacks": { "type": "array", "items": { "$ref": "#/components/schemas/Structure_StackGroupCamelCase" } } } }, "BetweenCamelCase": { "type": "object", "properties": { "high": { "$ref": "#/components/schemas/DatabaseValueCamelCase" }, "low": { "$ref": "#/components/schemas/DatabaseValueCamelCase" } } }, "PictureFilters_ColorMode_DuotoneCamelCase": { "type": "object", "properties": { "secondColor": { "$ref": "#/components/schemas/ColorCamelCase" }, "firstColor": { "$ref": "#/components/schemas/ColorCamelCase" } } }, "QuadraticTo": { "type": "object", "properties": { "control": { "$ref": "#/components/schemas/Point" }, "end": { "$ref": "#/components/schemas/Point" } } }, "ZoneContainerRef": { "type": "object", "properties": { "zone_id": { "type": "string" }, "index_path": { "$ref": "#/components/schemas/IndexPath" }, "object_id": { "type": "string" } } }, "Shape_Star_Scroll": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Scroll_ScrollType" } } }, "Structure_Spacing_SpacingType": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "ERDKitSymbol_EntityTable_ERDEntityTableColumnTypeCamelCase": { "type": "string", "enum": [ "UNKNOWN_COLUMN_TYPE", "KEY", "FIELD", "TYPE" ] }, "DatabaseValue_MultiSelectCamelCase": { "type": "object", "properties": { "optionIds": { "type": "array", "items": { "type": "string" } } } }, "SortOrder": { "type": "string", "enum": [ "SORT_ORDER_UNSPECIFIED", "ASC", "DESC" ] }, "Point": { "type": "object", "properties": { "x": { "format": "float", "type": "string" }, "y": { "format": "float", "type": "string" } } }, "Chart_ChartAxis_AxisCross_CrossAt_AutoCross": { "type": "string", "enum": [ "ZERO", "MIN", "MAX" ] }, "Shape_Basic_Bracket_BracketType": { "type": "string", "enum": [ "DOUBLE", "RIGHT", "LEFT" ] }, "AutoLayoutCamelCase": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/AutoLayout_AutoLayoutModeCamelCase" }, "verticalAlign": { "$ref": "#/components/schemas/VerticalAlignTypeCamelCase" }, "padding": { "$ref": "#/components/schemas/InsetsCamelCase" }, "verticalScale": { "$ref": "#/components/schemas/AutoLayout_ScaleTypeCamelCase" }, "horizontalAlign": { "$ref": "#/components/schemas/HorizontalAlignTypeCamelCase" }, "horizontalScale": { "$ref": "#/components/schemas/AutoLayout_ScaleTypeCamelCase" }, "grid": { "$ref": "#/components/schemas/AutoLayout_GridCamelCase" }, "horizontalSpacing": { "$ref": "#/components/schemas/AutoLayout_SpacingCamelCase" }, "verticalSpacing": { "$ref": "#/components/schemas/AutoLayout_SpacingCamelCase" }, "wrap": { "type": "boolean" } } }, "Shape_Basic_Triangle_TriangleTypeCamelCase": { "type": "string", "enum": [ "ISOSCELES", "RIGHT_ANGLED" ] }, "SpaceManifestCamelCase": { "type": "object", "properties": { "frameRefs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRefCamelCase" } }, "zoneRefs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRefCamelCase" } }, "mediaRefs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRefCamelCase" } } } }, "VaniGraphicObjectCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "shape", "connector", "picture", "groupShape", "domainDiagram", "diagram", "structure", "table", "chart", "databaseTable", "stickyNote", "databaseTableView" ], "name": "graphic_object_type" } ], "properties": { "groupShape": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "shape": { "$ref": "#/components/schemas/VaniShapeCamelCase" }, "picture": { "$ref": "#/components/schemas/PictureCamelCase" }, "structure": { "$ref": "#/components/schemas/StructureCamelCase" }, "diagram": { "$ref": "#/components/schemas/DiagramCamelCase" }, "stickyNote": { "$ref": "#/components/schemas/VaniGraphicObject_StickyNoteCamelCase" }, "connector": { "$ref": "#/components/schemas/ConnectorCamelCase" }, "domainDiagram": { "$ref": "#/components/schemas/DomainDiagramCamelCase" }, "databaseTableView": { "$ref": "#/components/schemas/DatabaseTableViewCamelCase" }, "name": { "type": "string" }, "databaseTable": { "$ref": "#/components/schemas/DatabaseTableCamelCase" }, "id": { "type": "string" }, "chart": { "$ref": "#/components/schemas/ChartCamelCase" }, "table": { "$ref": "#/components/schemas/TableCamelCase" } } }, "SpecVersion": { "type": "object", "properties": { "patch": { "format": "int32", "type": "string" }, "major": { "format": "int32", "type": "string" }, "minor": { "format": "int32", "type": "string" } } }, "GraphicObjectProperties": { "type": "object", "properties": { "strokes": { "type": "array", "items": { "$ref": "#/components/schemas/Stroke" } }, "stroke_style": { "$ref": "#/components/schemas/AssetRef" }, "shadow": { "$ref": "#/components/schemas/Shadow" }, "reflection": { "$ref": "#/components/schemas/Reflection" }, "effect_style": { "$ref": "#/components/schemas/AssetRef" }, "region_id": { "type": "string" }, "fill_style": { "$ref": "#/components/schemas/AssetRef" }, "spacing_style": { "$ref": "#/components/schemas/AssetRef" }, "data_binding": { "type": "string" }, "layer_style": { "$ref": "#/components/schemas/AssetRef" }, "layout": { "$ref": "#/components/schemas/Layout" }, "image_style": { "$ref": "#/components/schemas/AssetRef" }, "placeholder": { "$ref": "#/components/schemas/Placeholder" }, "fills": { "type": "array", "items": { "$ref": "#/components/schemas/Fill" } } } }, "DomainDiagram": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "uml", "dfd", "erd" ], "name": "diagram_type" } ], "properties": { "layout": { "$ref": "#/components/schemas/DomainDiagram_DiagramLayout" }, "dfd": { "$ref": "#/components/schemas/DomainDiagram_DfdDiagram" }, "uml": { "$ref": "#/components/schemas/DomainDiagram_UmlDiagram" }, "erd": { "$ref": "#/components/schemas/DomainDiagram_ErdDiagram" }, "type": { "$ref": "#/components/schemas/DomainDiagram_DiagramType" } } }, "Layout_Constraints_VerticalConstraintCamelCase": { "type": "string", "enum": [ "TOP", "BOTTOM", "MIDDLE", "TOP_BOTTOM", "VERTICAL_SCALE" ] }, "Shape_Basic_SnipRectangle": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_SnipRectangle_SnipRectangleType" } } }, "UpdateObjectFacetOp": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "properties", "picture_filters", "text_properties" ], "name": "facet" } ], "properties": { "picture_filters": { "$ref": "#/components/schemas/PictureFilters" }, "text_properties": { "$ref": "#/components/schemas/TextProperties" }, "update_mask": { "$ref": "#/components/schemas/FieldMask" }, "properties": { "$ref": "#/components/schemas/GraphicObjectProperties" }, "object": { "$ref": "#/components/schemas/ObjectRef" } } }, "Chart_AreaChart": { "type": "object", "properties": { "drop_lines": { "$ref": "#/components/schemas/Stroke" }, "grouping": { "$ref": "#/components/schemas/Chart_Grouping" } } }, "Chart_ChartAxisCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "valueAxis" ], "name": "axis_type" } ], "properties": { "axisTitle": { "$ref": "#/components/schemas/Chart_ChartTitleCamelCase" }, "crossAxis": { "$ref": "#/components/schemas/Chart_ChartAxis_AxisCrossCamelCase" }, "valueAxis": { "$ref": "#/components/schemas/Chart_ChartAxis_ValueAxisCamelCase" }, "majorGrid": { "$ref": "#/components/schemas/StrokeCamelCase" }, "minorGrid": { "$ref": "#/components/schemas/StrokeCamelCase" }, "minorTick": { "$ref": "#/components/schemas/StrokeCamelCase" }, "majorTick": { "$ref": "#/components/schemas/StrokeCamelCase" }, "position": { "$ref": "#/components/schemas/Chart_ChartAxis_PositionElementCamelCase" }, "axisId": { "type": "string" } } }, "VaniGraphicObject_GroupShape_GroupObjectCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "shape", "connector", "picture", "groupShape", "stickyNote" ], "name": "graphic_object_type" } ], "properties": { "groupShape": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "stickyNote": { "$ref": "#/components/schemas/VaniGraphicObject_StickyNoteCamelCase" }, "shape": { "$ref": "#/components/schemas/VaniShapeCamelCase" }, "connector": { "$ref": "#/components/schemas/ConnectorCamelCase" }, "name": { "type": "string" }, "id": { "type": "string" }, "picture": { "$ref": "#/components/schemas/PictureCamelCase" } } }, "AutoLayout_ScaleType": { "type": "string", "enum": [ "FIXED", "FILL", "HUG" ] }, "Layout_Constraints_HorizontalConstraintCamelCase": { "type": "string", "enum": [ "LEFT", "RIGHT", "CENTER", "LEFT_RIGHT", "HORIZONTAL_SCALE" ] }, "Shadow_ShadowTypeCamelCase": { "type": "string", "enum": [ "INNER", "OUTER" ] }, "VaniGraphicObject_GroupShape_GroupObject": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "shape", "connector", "picture", "group_shape", "sticky_note" ], "name": "graphic_object_type" } ], "properties": { "shape": { "$ref": "#/components/schemas/VaniShape" }, "connector": { "$ref": "#/components/schemas/Connector" }, "sticky_note": { "$ref": "#/components/schemas/VaniGraphicObject_StickyNote" }, "name": { "type": "string" }, "group_shape": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "id": { "type": "string" }, "picture": { "$ref": "#/components/schemas/Picture" } } }, "DFDKitSymbol_DFDComponentCamelCase": { "type": "string", "enum": [ "UNKNOWN", "EXTERNAL_ENTITY", "PROCESS", "DATA_STORE", "DATA_FLOW" ] }, "LineTo": { "type": "object", "properties": { "point": { "$ref": "#/components/schemas/Point" } } }, "Stroke_StrokeType": { "type": "string", "enum": [ "SOLID", "DASH", "ROUND_DOT", "SQUARE_DOT", "LONG_DASH", "DASHDOT", "LONG_DASH_DOT", "LONG_DASH_DOT_DOT", "DASH_PATTERN" ] }, "LibraryAssetRefCamelCase": { "type": "object", "properties": { "assetId": { "type": "string" }, "libraryId": { "type": "string" } } }, "Chart_BubbleChartCamelCase": { "type": "object", "properties": { "bubbleSize": { "$ref": "#/components/schemas/Chart_BubbleChart_BubbleSizeCamelCase" } } }, "Chart_GroupingCamelCase": { "type": "string", "enum": [ "CLUSTERED", "STACKED", "PERCENT_STACKED" ] }, "PictureFilters_ColorMode_Sepia": { "type": "object", "properties": {} }, "Shape_BlockArrow_CurvedArrow": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowType" } } }, "Shape_Star": { "type": "object", "properties": { "ribbon": { "$ref": "#/components/schemas/Shape_Star_Ribbon" }, "scroll": { "$ref": "#/components/schemas/Shape_Star_Scroll" }, "type": { "$ref": "#/components/schemas/StarType" }, "point": { "$ref": "#/components/schemas/Shape_Star_Point" }, "wave": { "$ref": "#/components/schemas/Shape_Star_Wave" } } }, "Layout_FollowAutoLayoutType": { "type": "string", "enum": [ "FILL", "FIXED" ] }, "ParaStyle_ListStyleCamelCase": { "type": "object", "properties": { "number": { "$ref": "#/components/schemas/ParaStyle_ListStyle_NumberBulletCamelCase" }, "character": { "$ref": "#/components/schemas/ParaStyle_ListStyle_CharacterBulletCamelCase" }, "color": { "$ref": "#/components/schemas/ColorCamelCase" }, "type": { "$ref": "#/components/schemas/ParaStyle_ListStyle_BulletTypeCamelCase" } } }, "TextProperties_TextBoxAutoFit": { "type": "string", "enum": [ "NONE", "TEXT", "SHAPE" ] }, "Chart_PieChart_RepresentativePie_RepresentativePieTypeCamelCase": { "type": "string", "enum": [ "BAR", "PIE" ] }, "Shape_Star_Scroll_ScrollType": { "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "FrameContainerRef": { "type": "object", "properties": { "zone_id": { "type": "string" }, "index_path": { "$ref": "#/components/schemas/IndexPath" }, "object_id": { "type": "string" }, "frame_id": { "type": "string" } } }, "VaniGraphicObject_GroupShapeCamelCase": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape_GroupObjectCamelCase" } }, "autoLayout": { "$ref": "#/components/schemas/AutoLayoutCamelCase" } } }, "StarTypeCamelCase": { "type": "string", "enum": [ "STAR_TYPE_UNSPECIFIED", "EXPLOSION", "POINT", "RIBBON", "SCROLL", "WAVE" ] }, "Table_TableColumn": { "type": "object", "properties": { "width": { "format": "float", "type": "string" }, "id": { "type": "string" } } }, "Chart_LineSetting_DataMarker": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Chart_LineSetting_DataMarker_DataMarkerType" }, "fill": { "$ref": "#/components/schemas/Fill" }, "stroke": { "$ref": "#/components/schemas/Stroke" } } }, "Structure_Kanban_HorizontalKanban": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/Structure_Spacing" }, "stacks": { "type": "array", "items": { "$ref": "#/components/schemas/Structure_StackGroup" } } } }, "ListOperationResultCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "zones", "frames", "zoneSlots", "objects" ], "name": "result" } ], "properties": { "zoneSlots": { "$ref": "#/components/schemas/ZoneSlotListCamelCase" }, "frames": { "$ref": "#/components/schemas/FrameListCamelCase" }, "nextPageToken": { "type": "string" }, "objects": { "$ref": "#/components/schemas/ObjectListCamelCase" }, "operationId": { "type": "string" }, "requestedOpKind": { "$ref": "#/components/schemas/ListOperationKindCamelCase" }, "zones": { "$ref": "#/components/schemas/ZoneListCamelCase" }, "error": { "$ref": "#/components/schemas/DataErrorCamelCase" } } }, "AssetRef": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "local_id", "library" ], "name": "source" } ], "properties": { "library": { "$ref": "#/components/schemas/LibraryAssetRef" }, "local_id": { "type": "string" } } }, "CubicTo": { "type": "object", "properties": { "control2": { "$ref": "#/components/schemas/Point" }, "control1": { "$ref": "#/components/schemas/Point" }, "end": { "$ref": "#/components/schemas/Point" } } }, "DatabaseTable_DatabaseRow": { "type": "object", "properties": { "cells": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseRow_DatabaseCell" } }, "id": { "type": "string" } } }, "Placeholder": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Placeholder_PlaceholderType" } } }, "Shape_Basic_SnipRectangleCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_SnipRectangle_SnipRectangleTypeCamelCase" } } }, "ListOperationDataResponseCamelCase": { "type": "object", "properties": { "revisionId": { "type": "string" }, "result": { "$ref": "#/components/schemas/ListOperationResultCamelCase" }, "error": { "$ref": "#/components/schemas/DataErrorCamelCase" } } }, "DatabaseTable_DatabaseColumn_CategoryColumn_CategoryCamelCase": { "type": "object", "properties": { "name": { "type": "string" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_ColumnOptionCamelCase" } }, "id": { "type": "string" } } }, "TextProperties_MarginCamelCase": { "type": "object", "properties": { "top": { "format": "float", "type": "string" }, "left": { "format": "float", "type": "string" }, "bottom": { "format": "float", "type": "string" }, "right": { "format": "float", "type": "string" } } }, "BasicShapeTypeCamelCase": { "type": "string", "enum": [ "BASIC_SHAPE_TYPE_UNSPECIFIED", "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" ] }, "Structure_Stack": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "vertical", "horizontal" ], "name": "stack_layout" } ], "properties": { "container": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "horizontal": { "$ref": "#/components/schemas/Structure_StackGroup" }, "vertical": { "$ref": "#/components/schemas/Structure_StackGroup" }, "table_view_id": { "type": "string" } } }, "CustomShape": { "type": "object", "properties": { "paths": { "type": "array", "items": { "$ref": "#/components/schemas/Path" } }, "width": { "format": "float", "type": "string" }, "height": { "format": "float", "type": "string" } } }, "ConnectorCamelCase": { "type": "object", "properties": { "connected": { "$ref": "#/components/schemas/Connector_ConnectedShapeCamelCase" }, "text": { "$ref": "#/components/schemas/TextCamelCase" }, "type": { "$ref": "#/components/schemas/Connector_ConnectorTypeCamelCase" }, "stroke": { "$ref": "#/components/schemas/StrokeCamelCase" } } }, "ViewConfig": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/Filter" }, "visible_column_ids": { "type": "array", "items": { "type": "string" } }, "group_by_column_id": { "type": "string" }, "sort": { "type": "array", "items": { "$ref": "#/components/schemas/Sort" } } } }, "DeleteZoneSlotOp": { "type": "object", "properties": { "zone_slot_ref": { "$ref": "#/components/schemas/ZoneSlotRef" } } }, "UpdateZoneSlotOp": { "type": "object", "properties": { "zone_slot": { "$ref": "#/components/schemas/Zone_ZoneObjectSlot" }, "zone_slot_ref": { "$ref": "#/components/schemas/ZoneSlotRef" } } }, "AutoLayout_AutoLayoutModeCamelCase": { "type": "string", "enum": [ "NONE", "HORIZONTAL", "VERTICAL", "GRID" ] }, "Stroke": { "type": "object", "properties": { "captype": { "$ref": "#/components/schemas/Stroke_CapType" }, "jointype": { "$ref": "#/components/schemas/Stroke_JoinType" }, "width": { "format": "float", "type": "string" }, "position": { "$ref": "#/components/schemas/Stroke_StrokePosition" }, "type": { "$ref": "#/components/schemas/Stroke_StrokeType" }, "fill": { "$ref": "#/components/schemas/Fill" }, "dash_pattern": { "type": "array", "items": { "format": "float", "type": "string" } } } }, "AutoLayout_AutoLayoutMode": { "type": "string", "enum": [ "NONE", "HORIZONTAL", "VERTICAL", "GRID" ] }, "DatabaseTable_DatabaseColumn_LookupColumn": { "type": "object", "properties": { "source_column_id": { "type": "string" }, "relation_column_id": { "type": "string" } } }, "BoolOpCamelCase": { "type": "string", "enum": [ "BOOL_OP_UNSPECIFIED", "AND", "OR" ] }, "DataErrorCamelCase": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/DataError_CodeCamelCase" }, "message": { "type": "string" } } }, "DomainDiagram_ErdNodeCamelCase": { "type": "object", "properties": { "erd": { "$ref": "#/components/schemas/ERDKitSymbolCamelCase" }, "id": { "type": "string" } } }, "FrameCamelCase": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/FrameMetaCamelCase" }, "frameId": { "type": "string" }, "graphicObjects": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObjectCamelCase" } }, "type": { "$ref": "#/components/schemas/FrameTypeCamelCase" }, "properties": { "$ref": "#/components/schemas/GraphicObjectPropertiesCamelCase" } } }, "ParaStyle_ListStyle_NumberBulletCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ParaStyle_ListStyle_NumberBullet_NumberBulletTypeCamelCase" }, "startat": { "format": "int32", "type": "string" } } }, "BlockArrowTypeCamelCase": { "type": "string", "enum": [ "BLOCK_ARROW_TYPE_UNSPECIFIED", "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" ] }, "Shape_Star_PointCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Point_StarPointTypeCamelCase" } } }, "DomainDiagram_DfdDiagramCamelCase": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramConnectorCamelCase" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DfdNodeCamelCase" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramEdgeCamelCase" } } } }, "ParaStyle_Spacing": { "type": "object", "properties": { "before": { "format": "int32", "type": "string" }, "line": { "format": "float", "type": "string" }, "after": { "format": "int32", "type": "string" } } }, "Structure_MindmapCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "right", "left", "top", "bottom", "leftRight", "topDown" ], "name": "mindmap_layout" } ], "properties": { "container": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "topDown": { "$ref": "#/components/schemas/Structure_Mindmap_TopDownGroupShapeCamelCase" }, "spacing": { "$ref": "#/components/schemas/Structure_SpacingCamelCase" }, "top": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "left": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "bottom": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "templateObject": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "root": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "right": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "leftRight": { "$ref": "#/components/schemas/Structure_Mindmap_LeftRightGroupShapeCamelCase" } } }, "Fill_GradientFill_RadialAngularGeometryCamelCase": { "type": "object", "properties": { "spreadX": { "format": "float", "type": "string" }, "flipHorizontal": { "type": "boolean" }, "center": { "$ref": "#/components/schemas/PointCamelCase" }, "spreadY": { "format": "float", "type": "string" }, "rotationAngle": { "format": "float", "type": "string" }, "flipVertical": { "type": "boolean" } } }, "DatabaseTable_DatabaseColumn_RollupColumnCamelCase": { "type": "object", "properties": { "relationColumnId": { "type": "string" }, "sourceColumnId": { "type": "string" }, "aggregate": { "$ref": "#/components/schemas/AggregateCamelCase" } } }, "TableCamelCase": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/LayoutCamelCase" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/Table_TableColumnCamelCase" } }, "styleRef": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "style": { "$ref": "#/components/schemas/TableStyleCamelCase" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/Table_TableRowCamelCase" } } } }, "Shape_BlockArrow": { "type": "object", "properties": { "double_arrow": { "$ref": "#/components/schemas/Shape_BlockArrow_DoubleArrow" }, "curved_arrow": { "$ref": "#/components/schemas/Shape_BlockArrow_CurvedArrow" }, "arrow_callout": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowCallout" }, "type": { "$ref": "#/components/schemas/BlockArrowType" }, "single_arrow": { "$ref": "#/components/schemas/Shape_BlockArrow_SingleArrow" } } }, "StarType": { "type": "string", "enum": [ "STAR_TYPE_UNSPECIFIED", "EXPLOSION", "POINT", "RIBBON", "SCROLL", "WAVE" ] }, "AssetRefCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "localId", "library" ], "name": "source" } ], "properties": { "library": { "$ref": "#/components/schemas/LibraryAssetRefCamelCase" }, "localId": { "type": "string" } } }, "ZoneSlotRef": { "type": "object", "properties": { "zone_id": { "type": "string" }, "index": { "format": "int32", "type": "string" } } }, "Connector_MarkerTypeCamelCase": { "type": "string", "enum": [ "DEF_MARKER_TYPE", "NONE", "OPEN", "BLOCK", "CLASSIC", "DIAMOND", "OVAL" ] }, "Aggregate_CommonCamelCase": { "type": "string", "enum": [ "COMMON_UNSPECIFIED", "COUNT", "COUNT_EMPTY", "COUNT_NOT_EMPTY", "COUNT_UNIQUE", "PERCENT_EMPTY", "PERCENT_NOT_EMPTY" ] }, "Shape_Star_Point_StarPointType": { "type": "string", "enum": [ "FOUR_POINT", "FIVE_POINT", "SIX_POINT", "SEVEN_POINT", "EIGHT_POINT", "TEN_POINT", "TWELVE_POINT", "SIXTEEN_POINT", "TWENTY_FOUR_POINT", "THIRTY_TWO_POINT" ] }, "Table_TableRowCamelCase": { "type": "object", "properties": { "cells": { "type": "array", "items": { "$ref": "#/components/schemas/Table_TableRow_TableCellCamelCase" } }, "id": { "type": "string" }, "height": { "format": "float", "type": "string" } } }, "AutoLayout_ScaleTypeCamelCase": { "type": "string", "enum": [ "FIXED", "FILL", "HUG" ] }, "KitShape": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "dfd", "uml", "erd" ], "name": "props" } ], "properties": { "dfd": { "$ref": "#/components/schemas/DFDKitSymbol" }, "uml": { "$ref": "#/components/schemas/UMLKitSymbol" }, "erd": { "$ref": "#/components/schemas/ERDKitSymbol" }, "kit": { "$ref": "#/components/schemas/KitShape_BaseKitType" } } }, "Fill_NoFillCamelCase": { "type": "object", "properties": {} }, "Aggregate_BooleanCamelCase": { "type": "string", "enum": [ "BOOLEAN_UNSPECIFIED", "CHECKED", "UNCHECKED", "PERCENT_CHECKED", "PERCENT_UNCHECKED" ] }, "KitShapeCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "dfd", "uml", "erd" ], "name": "props" } ], "properties": { "dfd": { "$ref": "#/components/schemas/DFDKitSymbolCamelCase" }, "uml": { "$ref": "#/components/schemas/UMLKitSymbolCamelCase" }, "erd": { "$ref": "#/components/schemas/ERDKitSymbolCamelCase" }, "kit": { "$ref": "#/components/schemas/KitShape_BaseKitTypeCamelCase" } } }, "Placeholder_PlaceholderTypeCamelCase": { "type": "string", "enum": [ "TITLE", "SUBTITLE", "CONTENT", "IMAGE", "CHART", "TABLE", "CALL_TO_ACTION", "LOGO" ] }, "TextProperties": { "type": "object", "properties": { "text_style": { "$ref": "#/components/schemas/AssetRef" }, "inset": { "$ref": "#/components/schemas/TextProperties_Margin" }, "auto_fit": { "$ref": "#/components/schemas/TextProperties_TextBoxAutoFit" }, "valign": { "$ref": "#/components/schemas/VerticalAlignType" }, "para_style": { "$ref": "#/components/schemas/ParaStyle" } } }, "UpdateFrameMetaOp": { "type": "object", "properties": { "zone_id": { "type": "string" }, "frame_meta": { "$ref": "#/components/schemas/FrameMeta" }, "update_mask": { "$ref": "#/components/schemas/FieldMask" }, "frame_id": { "type": "string" } } }, "Aggregate_DateCamelCase": { "type": "string", "enum": [ "DATE_UNSPECIFIED", "EARLIEST", "LATEST", "DATE_RANGE" ] }, "Chart_LineChartCamelCase": { "type": "object", "properties": { "dropLines": { "$ref": "#/components/schemas/StrokeCamelCase" }, "downBar": { "$ref": "#/components/schemas/FillCamelCase" }, "upBar": { "$ref": "#/components/schemas/FillCamelCase" }, "grouping": { "$ref": "#/components/schemas/Chart_GroupingCamelCase" }, "highLowLines": { "$ref": "#/components/schemas/StrokeCamelCase" }, "lineSettings": { "$ref": "#/components/schemas/Chart_LineSettingCamelCase" } } }, "DomainDiagram_DiagramEdge": { "type": "object", "properties": { "from_node_id": { "type": "string" }, "connector_id": { "type": "string" }, "to_node_id": { "type": "string" } } }, "Table_TableRow_TableCell": { "type": "object", "properties": { "border": { "$ref": "#/components/schemas/Table_CellBorder" }, "merge_cols": { "format": "int32", "type": "string" }, "merge_rows": { "format": "int32", "type": "string" }, "id": { "type": "string" }, "text": { "$ref": "#/components/schemas/Text" }, "is_merged": { "type": "boolean" }, "fill": { "$ref": "#/components/schemas/Fill" } } }, "Shadow_ShadowType": { "type": "string", "enum": [ "INNER", "OUTER" ] }, "Structure_Mindmap_LeftRightGroupShapeCamelCase": { "type": "object", "properties": { "left": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "right": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" } } }, "DiagramCamelCase": { "type": "object", "properties": {} }, "StructureCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "stack", "kanban", "mindmap" ], "name": "structure_type" } ], "properties": { "stack": { "$ref": "#/components/schemas/Structure_StackCamelCase" }, "kanban": { "$ref": "#/components/schemas/Structure_KanbanCamelCase" }, "mindmap": { "$ref": "#/components/schemas/Structure_MindmapCamelCase" }, "title": { "type": "string" } } }, "SortOrderCamelCase": { "type": "string", "enum": [ "SORT_ORDER_UNSPECIFIED", "ASC", "DESC" ] }, "Chart_BubbleChart_BubbleSize_RepresentBubbleSizeCamelCase": { "type": "string", "enum": [ "AREA", "WIDTH" ] }, "Shape_BlockArrow_DoubleArrow": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_DoubleArrow_DoubleArrowType" } } }, "Connector_ConnectedShape": { "type": "object", "properties": { "first": { "$ref": "#/components/schemas/Connector_Endpoint" }, "second": { "$ref": "#/components/schemas/Connector_Endpoint" } } }, "AutoLayout_Spacing_SpacingType": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "Stroke_JoinTypeCamelCase": { "type": "string", "enum": [ "ROUND", "BEVEL", "MITER" ] }, "Table_TableColumnCamelCase": { "type": "object", "properties": { "width": { "format": "float", "type": "string" }, "id": { "type": "string" } } }, "ColumnRef": { "type": "object", "properties": { "column_id": { "type": "string" } } }, "Color_RGBColor": { "type": "object", "properties": { "red": { "format": "int32", "type": "string" }, "green": { "format": "int32", "type": "string" }, "blue": { "format": "int32", "type": "string" } } }, "Shape_Star_Point_StarPointTypeCamelCase": { "type": "string", "enum": [ "FOUR_POINT", "FIVE_POINT", "SIX_POINT", "SEVEN_POINT", "EIGHT_POINT", "TEN_POINT", "TWELVE_POINT", "SIXTEEN_POINT", "TWENTY_FOUR_POINT", "THIRTY_TWO_POINT" ] }, "Shape_BlockArrow_ArrowType": { "type": "string", "enum": [ "RIGHT", "LEFT", "TOP", "BOTTOM" ] }, "TextProperties_Margin": { "type": "object", "properties": { "top": { "format": "float", "type": "string" }, "left": { "format": "float", "type": "string" }, "bottom": { "format": "float", "type": "string" }, "right": { "format": "float", "type": "string" } } }, "ParaStyle_ListStyle_CharacterBullet_CharacterBulletTypeCamelCase": { "type": "string", "enum": [ "SOLID_CIRCLE", "HOLLOW_CIRCLE", "SOLID_SQUARE", "HOLLOW_SQUARE", "SOLID_DIAMOND", "ARROW_HEAD", "CHECK_MARK" ] }, "Shape_BlockArrow_DoubleArrowCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_DoubleArrow_DoubleArrowTypeCamelCase" } } }, "Structure_StackGroup": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/Structure_Spacing" }, "title": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" } } } }, "Chart_ChartAxis_PositionElement": { "type": "string", "enum": [ "TOP", "LEFT", "BOTTOM", "RIGHT", "CENTER" ] }, "Shadow": { "type": "object", "properties": { "distance": { "format": "float", "type": "string" }, "color": { "$ref": "#/components/schemas/Color" }, "transparency": { "format": "float", "type": "string" }, "angle": { "format": "float", "type": "string" }, "blur": { "format": "float", "type": "string" }, "type": { "$ref": "#/components/schemas/Shadow_ShadowType" } } }, "DataError_CodeCamelCase": { "type": "string", "enum": [ "CODE_UNSPECIFIED", "INVALID_ARGUMENT", "NOT_FOUND", "ALREADY_EXISTS", "FAILED_PRECONDITION", "CONFLICT", "INTERNAL" ] }, "Fill_PictureFill": { "type": "object", "properties": { "offset_top": { "format": "float", "type": "string" }, "scale_y": { "format": "float", "type": "string" }, "scale_x": { "format": "float", "type": "string" }, "media": { "$ref": "#/components/schemas/AssetRef" }, "type": { "$ref": "#/components/schemas/Fill_PictureFill_PictureFillType" }, "offset_left": { "format": "float", "type": "string" } } }, "Shape_Basic_RoundedRectangle_RoundedRectangleType": { "type": "string", "enum": [ "NORMAL", "SINGLE", "SAME_SIDE", "DIAGONAL" ] }, "DatabaseTableView": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "grid", "kanban" ], "name": "form" } ], "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "grid": { "$ref": "#/components/schemas/DatabaseTableView_GridForm" }, "kanban": { "$ref": "#/components/schemas/DatabaseTableView_KanbanForm" }, "name": { "type": "string" }, "view_config": { "$ref": "#/components/schemas/ViewConfig" }, "id": { "type": "string" }, "table_id": { "type": "string" } } }, "Shape_Basic_BracketCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Basic_Bracket_BracketTypeCamelCase" } } }, "SpaceManifest": { "type": "object", "properties": { "zone_refs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } }, "media_refs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } }, "frame_refs": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceRef" } } } }, "AutoLayout": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/AutoLayout_AutoLayoutMode" }, "vertical_scale": { "$ref": "#/components/schemas/AutoLayout_ScaleType" }, "horizontal_spacing": { "$ref": "#/components/schemas/AutoLayout_Spacing" }, "padding": { "$ref": "#/components/schemas/Insets" }, "horizontal_scale": { "$ref": "#/components/schemas/AutoLayout_ScaleType" }, "vertical_align": { "$ref": "#/components/schemas/VerticalAlignType" }, "grid": { "$ref": "#/components/schemas/AutoLayout_Grid" }, "horizontal_align": { "$ref": "#/components/schemas/HorizontalAlignType" }, "vertical_spacing": { "$ref": "#/components/schemas/AutoLayout_Spacing" }, "wrap": { "type": "boolean" } } }, "Aggregate_Number": { "type": "string", "enum": [ "NUMBER_UNSPECIFIED", "SUM", "AVG", "MIN", "MAX", "MEDIAN", "RANGE" ] }, "Shape_BasicCamelCase": { "type": "object", "properties": { "bracket": { "$ref": "#/components/schemas/Shape_Basic_BracketCamelCase" }, "brace": { "$ref": "#/components/schemas/Shape_Basic_BracketCamelCase" }, "roundedRectangle": { "$ref": "#/components/schemas/Shape_Basic_RoundedRectangleCamelCase" }, "snipRectangle": { "$ref": "#/components/schemas/Shape_Basic_SnipRectangleCamelCase" }, "type": { "$ref": "#/components/schemas/BasicShapeTypeCamelCase" }, "triangle": { "$ref": "#/components/schemas/Shape_Basic_TriangleCamelCase" } } }, "Aggregate_Text": { "type": "string", "enum": [ "TEXT_UNSPECIFIED", "CONCAT", "CONCAT_UNIQUE" ] }, "DFDKitSymbol_DFDComponent": { "type": "string", "enum": [ "UNKNOWN", "EXTERNAL_ENTITY", "PROCESS", "DATA_STORE", "DATA_FLOW" ] }, "ERDKitSymbol_Cardinality": { "type": "string", "enum": [ "UNKNOWN_CARDINALITY", "ONE", "MANY", "ONE_MANDATORY", "ZERO_OR_ONE", "ONE_OR_MANY", "ZERO_OR_MANY" ] }, "DomainDiagram_UmlNode": { "type": "object", "properties": { "uml": { "$ref": "#/components/schemas/UMLKitSymbol" }, "id": { "type": "string" } } }, "Stroke_StrokePosition": { "type": "string", "enum": [ "CENTER", "INSIDE", "OUTSIDE" ] }, "Structure_Kanban_VerticalKanbanCamelCase": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/Structure_SpacingCamelCase" }, "stacks": { "type": "array", "items": { "$ref": "#/components/schemas/Structure_StackGroupCamelCase" } } } }, "Structure_Mindmap_LeftRightGroupShape": { "type": "object", "properties": { "left": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "right": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" } } }, "Connector_Endpoint": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "side", "point" ], "name": "attach" } ], "properties": { "side": { "$ref": "#/components/schemas/Connector_ConnectionSide" }, "marker": { "$ref": "#/components/schemas/Connector_MarkerType" }, "shape_id": { "type": "string" }, "point": { "$ref": "#/components/schemas/Point" } } }, "TableStyle": { "type": "object", "properties": { "band_row": { "type": "boolean" }, "first_col": { "type": "boolean" }, "band_col": { "type": "boolean" }, "first_row": { "type": "boolean" }, "last_row": { "type": "boolean" }, "fill": { "$ref": "#/components/schemas/Fill" }, "stroke": { "$ref": "#/components/schemas/Stroke" }, "last_col": { "type": "boolean" } } }, "PathCommand": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "move_to", "line_to", "cubic_to", "quadratic_to", "arc_to", "smooth_cubic_to", "smooth_quadratic_to", "close_path" ], "name": "command" } ], "properties": { "smooth_cubic_to": { "$ref": "#/components/schemas/SmoothCubicTo" }, "close_path": { "$ref": "#/components/schemas/ClosePath" }, "arc_to": { "$ref": "#/components/schemas/ArcTo" }, "move_to": { "$ref": "#/components/schemas/MoveTo" }, "quadratic_to": { "$ref": "#/components/schemas/QuadraticTo" }, "line_to": { "$ref": "#/components/schemas/LineTo" }, "cubic_to": { "$ref": "#/components/schemas/CubicTo" }, "smooth_quadratic_to": { "$ref": "#/components/schemas/SmoothQuadraticTo" } } }, "DatabaseValueCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "text", "number", "checkbox", "select", "multiSelect", "category", "date", "person", "email", "relation", "toggle", "rating", "phone", "url" ], "name": "value" } ], "properties": { "date": { "type": "string" }, "select": { "type": "string" }, "rating": { "format": "int32", "type": "string" }, "toggle": { "type": "boolean" }, "url": { "type": "string" }, "relation": { "$ref": "#/components/schemas/DatabaseValue_RelationValueCamelCase" }, "number": { "format": "float", "type": "string" }, "phone": { "type": "string" }, "person": { "type": "string" }, "checkbox": { "type": "boolean" }, "text": { "type": "string" }, "category": { "type": "string" }, "email": { "type": "string" }, "multiSelect": { "$ref": "#/components/schemas/DatabaseValue_MultiSelectCamelCase" } } }, "Shape_BlockArrow_SingleArrowCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowTypeCamelCase" } } }, "Connector_MarkerType": { "type": "string", "enum": [ "DEF_MARKER_TYPE", "NONE", "OPEN", "BLOCK", "CLASSIC", "DIAMOND", "OVAL" ] }, "ShadowCamelCase": { "type": "object", "properties": { "distance": { "format": "float", "type": "string" }, "color": { "$ref": "#/components/schemas/ColorCamelCase" }, "transparency": { "format": "float", "type": "string" }, "angle": { "format": "float", "type": "string" }, "blur": { "format": "float", "type": "string" }, "type": { "$ref": "#/components/schemas/Shadow_ShadowTypeCamelCase" } } }, "Shape_BlockArrow_DoubleArrow_DoubleArrowType": { "type": "string", "enum": [ "UP_DOWN", "LEFT_RIGHT", "LEFT_UP" ] }, "TextMatchOpCamelCase": { "type": "string", "enum": [ "TEXT_MATCH_OP_UNSPECIFIED", "CONTAINS", "STARTS_WITH", "ENDS_WITH" ] }, "ClosePathCamelCase": { "type": "object", "properties": {} }, "Chart_ChartAxis": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "value_axis" ], "name": "axis_type" } ], "properties": { "minor_tick": { "$ref": "#/components/schemas/Stroke" }, "cross_axis": { "$ref": "#/components/schemas/Chart_ChartAxis_AxisCross" }, "axis_id": { "type": "string" }, "axis_title": { "$ref": "#/components/schemas/Chart_ChartTitle" }, "position": { "$ref": "#/components/schemas/Chart_ChartAxis_PositionElement" }, "major_grid": { "$ref": "#/components/schemas/Stroke" }, "value_axis": { "$ref": "#/components/schemas/Chart_ChartAxis_ValueAxis" }, "major_tick": { "$ref": "#/components/schemas/Stroke" }, "minor_grid": { "$ref": "#/components/schemas/Stroke" } } }, "Fill_GradientFill_GradientFillType": { "type": "string", "enum": [ "LINEAR", "RADIAL", "RECTANGULAR", "PATH", "ANGULAR" ] }, "ParaStyle_ListStyle_CharacterBullet_CharacterBulletType": { "type": "string", "enum": [ "SOLID_CIRCLE", "HOLLOW_CIRCLE", "SOLID_SQUARE", "HOLLOW_SQUARE", "SOLID_DIAMOND", "ARROW_HEAD", "CHECK_MARK" ] }, "Chart_LineSettingCamelCase": { "type": "object", "properties": { "marker": { "$ref": "#/components/schemas/Chart_LineSetting_DataMarkerCamelCase" }, "smooth": { "type": "boolean" } } }, "PortionStyle_FontName": { "type": "object", "properties": { "name": { "type": "string" }, "style": { "type": "string" } } }, "VaniGraphicObject_StickyNote": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "type": { "$ref": "#/components/schemas/VaniGraphicObject_StickyNote_StickyNoteType" } } }, "DatabaseTable_ColumnTypeCamelCase": { "type": "string", "enum": [ "TEXT", "NUMBER", "TOGGLE", "CHECKBOX", "SELECT", "MULTI_SELECT", "CATEGORY", "DATE", "PERSON", "PHONE", "EMAIL", "URL", "RATING", "RELATION", "LOOKUP", "ROLLUP" ] }, "Structure_StackGroupCamelCase": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/Structure_SpacingCamelCase" }, "title": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" } } } }, "Filter": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/BoolOp" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/Condition" } } } }, "ObjectListCamelCase": { "type": "object", "properties": { "objects": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObjectCamelCase" } } } }, "DomainDiagram_UmlNodeCamelCase": { "type": "object", "properties": { "uml": { "$ref": "#/components/schemas/UMLKitSymbolCamelCase" }, "id": { "type": "string" } } }, "Stroke_StrokeTypeCamelCase": { "type": "string", "enum": [ "SOLID", "DASH", "ROUND_DOT", "SQUARE_DOT", "LONG_DASH", "DASHDOT", "LONG_DASH_DOT", "LONG_DASH_DOT_DOT", "DASH_PATTERN" ] }, "VaniShapeCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "shape", "kit" ], "name": "shape_type" } ], "properties": { "shape": { "$ref": "#/components/schemas/ShapeCamelCase" }, "kit": { "$ref": "#/components/schemas/KitShapeCamelCase" } } }, "FrameTypeCamelCase": { "type": "string", "enum": [ "FRAME_TYPE_UNSPECIFIED", "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" ] }, "CalloutType": { "type": "string", "enum": [ "CALLOUT_TYPE_UNSPECIFIED", "LINE", "RECTANGLE_CALLOUT", "ROUNDED_RECTANGLE_CALLOUT", "OVAL_CALLOUT", "CLOUD_CALLOUT" ] }, "DFDKitSymbolCamelCase": { "type": "object", "properties": { "component": { "$ref": "#/components/schemas/DFDKitSymbol_DFDComponentCamelCase" }, "notation": { "$ref": "#/components/schemas/DFDKitSymbol_DFDNotationCamelCase" } } }, "Fill_PictureFill_PictureFillType": { "type": "string", "enum": [ "SCALE", "TILE" ] }, "Structure_StackCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "vertical", "horizontal" ], "name": "stack_layout" } ], "properties": { "container": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShapeCamelCase" }, "horizontal": { "$ref": "#/components/schemas/Structure_StackGroupCamelCase" }, "vertical": { "$ref": "#/components/schemas/Structure_StackGroupCamelCase" }, "tableViewId": { "type": "string" } } }, "ComparisonCamelCase": { "type": "object", "properties": { "op": { "$ref": "#/components/schemas/ComparisonOpCamelCase" }, "operand": { "$ref": "#/components/schemas/OperandCamelCase" } } }, "DatabaseTable_DatabaseRowCamelCase": { "type": "object", "properties": { "cells": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseRow_DatabaseCellCamelCase" } }, "id": { "type": "string" } } }, "PictureFilters_ColorMode_Duotone": { "type": "object", "properties": { "first_color": { "$ref": "#/components/schemas/Color" }, "second_color": { "$ref": "#/components/schemas/Color" } } }, "AutoLayout_Spacing_SpacingTypeCamelCase": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "EmptinessOpCamelCase": { "type": "string", "enum": [ "EMPTINESS_OP_UNSPECIFIED", "IS_EMPTY", "IS_NOT_EMPTY" ] }, "SmoothCubicToCamelCase": { "type": "object", "properties": { "control2": { "$ref": "#/components/schemas/PointCamelCase" }, "end": { "$ref": "#/components/schemas/PointCamelCase" } } }, "TextMatchOp": { "type": "string", "enum": [ "TEXT_MATCH_OP_UNSPECIFIED", "CONTAINS", "STARTS_WITH", "ENDS_WITH" ] }, "TableStyleCamelCase": { "type": "object", "properties": { "bandRow": { "type": "boolean" }, "firstRow": { "type": "boolean" }, "lastRow": { "type": "boolean" }, "firstCol": { "type": "boolean" }, "lastCol": { "type": "boolean" }, "fill": { "$ref": "#/components/schemas/FillCamelCase" }, "stroke": { "$ref": "#/components/schemas/StrokeCamelCase" }, "bandCol": { "type": "boolean" } } }, "Chart_PieChart": { "type": "object", "properties": { "explosion": { "format": "float", "type": "string" }, "representative_pie": { "$ref": "#/components/schemas/Chart_PieChart_RepresentativePie" }, "first_slice_angle": { "format": "float", "type": "string" } } }, "Zone_ZoneObjectSlotCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "frameId", "graphicObject" ], "name": "object" } ], "properties": { "graphicObject": { "$ref": "#/components/schemas/VaniGraphicObjectCamelCase" }, "frameId": { "type": "string" } } }, "FilterCamelCase": { "type": "object", "properties": { "mode": { "$ref": "#/components/schemas/BoolOpCamelCase" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionCamelCase" } } } }, "ParaStyle": { "type": "object", "properties": { "spacing": { "$ref": "#/components/schemas/ParaStyle_Spacing" }, "level": { "format": "int32", "type": "string" }, "portion_style": { "$ref": "#/components/schemas/PortionStyle" }, "halign": { "$ref": "#/components/schemas/HorizontalAlignType" }, "list_style": { "$ref": "#/components/schemas/ParaStyle_ListStyle" } } }, "DomainDiagram_DiagramLayoutCamelCase": { "type": "string", "enum": [ "LAYOUT_UNSPECIFIED", "TOP_DOWN", "LEFT_RIGHT" ] }, "PortionStyle_FontWeight": { "type": "string", "enum": [ "THIN", "EXTRA_LIGHT", "LIGHT", "NORMAL", "MEDIUM", "DEMI_BOLD", "BOLD", "HEAVY", "BLACK" ] }, "CubicToCamelCase": { "type": "object", "properties": { "control2": { "$ref": "#/components/schemas/PointCamelCase" }, "control1": { "$ref": "#/components/schemas/PointCamelCase" }, "end": { "$ref": "#/components/schemas/PointCamelCase" } } }, "FrameMeta": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "Fill_PictureFillCamelCase": { "type": "object", "properties": { "scaleX": { "format": "float", "type": "string" }, "offsetTop": { "format": "float", "type": "string" }, "scaleY": { "format": "float", "type": "string" }, "offsetLeft": { "format": "float", "type": "string" }, "media": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "type": { "$ref": "#/components/schemas/Fill_PictureFill_PictureFillTypeCamelCase" } } }, "ParaStyle_ListStyle": { "type": "object", "properties": { "number": { "$ref": "#/components/schemas/ParaStyle_ListStyle_NumberBullet" }, "character": { "$ref": "#/components/schemas/ParaStyle_ListStyle_CharacterBullet" }, "color": { "$ref": "#/components/schemas/Color" }, "type": { "$ref": "#/components/schemas/ParaStyle_ListStyle_BulletType" } } }, "DeleteObjectOp": { "type": "object", "properties": { "object": { "$ref": "#/components/schemas/ObjectRef" } } }, "VaniGraphicObject_StickyNote_StickyNoteTypeCamelCase": { "type": "string", "enum": [ "STICKY_NOTE_TYPE_UNSPECIFIED", "ARROW", "FLAG", "RING", "PLAIN", "CLIP", "PIN", "FOLDED" ] }, "Shape_Basic_Triangle_TriangleType": { "type": "string", "enum": [ "ISOSCELES", "RIGHT_ANGLED" ] }, "VerticalAlignTypeCamelCase": { "type": "string", "enum": [ "MIDDLE", "TOP", "BOTTOM" ] }, "Shape_FlowchartCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowchartTypeCamelCase" } } }, "Chart_LineSetting_DataMarker_DataMarkerType": { "type": "string", "enum": [ "CIRCLE", "DASH", "DIAMOND", "DOT" ] }, "ERDKitSymbol_EntityTableCamelCase": { "type": "object", "properties": { "columnTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ERDKitSymbol_EntityTable_ERDEntityTableColumnTypeCamelCase" } } } }, "Membership_Mode": { "type": "string", "enum": [ "MODE_UNSPECIFIED", "HAS_ANY", "HAS_ALL", "HAS_NONE" ] }, "ObjectFacetDataCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "properties", "pictureFilters", "textProperties" ], "name": "facet" } ], "properties": { "textProperties": { "$ref": "#/components/schemas/TextPropertiesCamelCase" }, "properties": { "$ref": "#/components/schemas/GraphicObjectPropertiesCamelCase" }, "pictureFilters": { "$ref": "#/components/schemas/PictureFiltersCamelCase" } } }, "Fill_GradientFill_GradientFillTypeCamelCase": { "type": "string", "enum": [ "LINEAR", "RADIAL", "RECTANGULAR", "PATH", "ANGULAR" ] }, "ColumnRefCamelCase": { "type": "object", "properties": { "columnId": { "type": "string" } } }, "Text_Paragraph_Portion": { "type": "object", "properties": { "style": { "$ref": "#/components/schemas/PortionStyle" }, "text": { "type": "string" } } }, "PointCamelCase": { "type": "object", "properties": { "x": { "format": "float", "type": "string" }, "y": { "format": "float", "type": "string" } } }, "Shape": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "basic", "block_arrow", "flowchart", "mathematical_symbol", "star", "callout", "custom" ], "name": "shape_type" } ], "properties": { "callout": { "$ref": "#/components/schemas/Shape_Callout" }, "mathematical_symbol": { "$ref": "#/components/schemas/Shape_MathematicalSymbol" }, "star": { "$ref": "#/components/schemas/Shape_Star" }, "custom": { "$ref": "#/components/schemas/CustomShape" }, "block_arrow": { "$ref": "#/components/schemas/Shape_BlockArrow" }, "flowchart": { "$ref": "#/components/schemas/Shape_Flowchart" }, "text": { "$ref": "#/components/schemas/Text" }, "basic": { "$ref": "#/components/schemas/Shape_Basic" }, "properties": { "$ref": "#/components/schemas/GraphicObjectProperties" } } }, "Structure_Kanban": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "horizontal", "vertical" ], "name": "kanban_layout" } ], "properties": { "container": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "horizontal": { "$ref": "#/components/schemas/Structure_Kanban_HorizontalKanban" }, "vertical": { "$ref": "#/components/schemas/Structure_Kanban_VerticalKanban" }, "table_view_id": { "type": "string" } } }, "KitShape_BaseKitType": { "type": "string", "enum": [ "UML", "DFD", "ERD" ] }, "VerticalAlignType": { "type": "string", "enum": [ "MIDDLE", "TOP", "BOTTOM" ] }, "Operand": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "value", "column" ], "name": "operand" } ], "properties": { "column": { "$ref": "#/components/schemas/ColumnRef" }, "value": { "$ref": "#/components/schemas/DatabaseValue" } } }, "Text_ParagraphCamelCase": { "type": "object", "properties": { "style": { "$ref": "#/components/schemas/ParaStyleCamelCase" }, "id": { "type": "string" }, "portions": { "type": "array", "items": { "$ref": "#/components/schemas/Text_Paragraph_PortionCamelCase" } } } }, "Chart_ScatterChartCamelCase": { "type": "object", "properties": { "line": { "type": "boolean" }, "lineSettings": { "$ref": "#/components/schemas/Chart_LineSettingCamelCase" } } }, "ERDKitSymbol": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "entity_table", "relationship" ], "name": "component_details" } ], "properties": { "entity_table": { "$ref": "#/components/schemas/ERDKitSymbol_EntityTable" }, "relationship": { "$ref": "#/components/schemas/ERDKitSymbol_Relationship" } } }, "DatabaseTableView_KanbanForm": { "type": "object", "properties": {} }, "DatabaseValue": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "text", "number", "checkbox", "select", "multi_select", "category", "date", "person", "email", "relation", "toggle", "rating", "phone", "url" ], "name": "value" } ], "properties": { "date": { "type": "string" }, "select": { "type": "string" }, "rating": { "format": "int32", "type": "string" }, "toggle": { "type": "boolean" }, "url": { "type": "string" }, "relation": { "$ref": "#/components/schemas/DatabaseValue_RelationValue" }, "number": { "format": "float", "type": "string" }, "multi_select": { "$ref": "#/components/schemas/DatabaseValue_MultiSelect" }, "phone": { "type": "string" }, "person": { "type": "string" }, "checkbox": { "type": "boolean" }, "text": { "type": "string" }, "category": { "type": "string" }, "email": { "type": "string" } } }, "VaniShape": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "shape", "kit" ], "name": "shape_type" } ], "properties": { "shape": { "$ref": "#/components/schemas/Shape" }, "kit": { "$ref": "#/components/schemas/KitShape" } } }, "PictureFilters_ColorMode_GrayScale": { "type": "object", "properties": {} }, "PictureFilters_ColorMode_BilevelCamelCase": { "type": "object", "properties": { "level": { "format": "float", "type": "string" } } }, "DFDKitSymbol": { "type": "object", "properties": { "component": { "$ref": "#/components/schemas/DFDKitSymbol_DFDComponent" }, "notation": { "$ref": "#/components/schemas/DFDKitSymbol_DFDNotation" } } }, "Aggregate_Date": { "type": "string", "enum": [ "DATE_UNSPECIFIED", "EARLIEST", "LATEST", "DATE_RANGE" ] }, "ParaStyle_ListStyle_NumberBullet_NumberBulletTypeCamelCase": { "type": "string", "enum": [ "NUMERIC_DOT", "NUMERIC_BRACKET", "UCROMAN_DOT", "LCROMAN_DOT", "UCALPHABET_DOT", "LC_ALPHABET_DOT" ] }, "DomainDiagram_DiagramType": { "type": "string", "enum": [ "UML", "DFD", "ERD" ] }, "Chart_LineSetting": { "type": "object", "properties": { "marker": { "$ref": "#/components/schemas/Chart_LineSetting_DataMarker" }, "smooth": { "type": "boolean" } } }, "Table": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/Table_TableColumn" } }, "style_ref": { "$ref": "#/components/schemas/AssetRef" }, "style": { "$ref": "#/components/schemas/TableStyle" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/Table_TableRow" } } } }, "Chart_BubbleChart_BubbleSize_RepresentBubbleSize": { "type": "string", "enum": [ "AREA", "WIDTH" ] }, "Structure_Mindmap": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "right", "left", "top", "bottom", "left_right", "top_down" ], "name": "mindmap_layout" } ], "properties": { "container": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "spacing": { "$ref": "#/components/schemas/Structure_Spacing" }, "template_object": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "top": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "left": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "bottom": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "root": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "top_down": { "$ref": "#/components/schemas/Structure_Mindmap_TopDownGroupShape" }, "right": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape" }, "left_right": { "$ref": "#/components/schemas/Structure_Mindmap_LeftRightGroupShape" } } }, "FrameMetaCamelCase": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "GetOperationDataResponseCamelCase": { "type": "object", "properties": { "revisionId": { "type": "string" }, "result": { "$ref": "#/components/schemas/GetOperationResultCamelCase" }, "error": { "$ref": "#/components/schemas/DataErrorCamelCase" } } }, "CalloutTypeCamelCase": { "type": "string", "enum": [ "CALLOUT_TYPE_UNSPECIFIED", "LINE", "RECTANGLE_CALLOUT", "ROUNDED_RECTANGLE_CALLOUT", "OVAL_CALLOUT", "CLOUD_CALLOUT" ] }, "HorizontalAlignType": { "type": "string", "enum": [ "LEFT", "CENTER", "RIGHT", "JUSTIFY" ] }, "DFDKitSymbol_DFDNotation": { "type": "string", "enum": [ "UNKNOWN_DFD", "YOURDON_AND_COAD", "GANE_AND_SARSON" ] }, "DatabaseTable_DatabaseColumn_SelectColumnCamelCase": { "type": "object", "properties": { "options": { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseTable_DatabaseColumn_ColumnOptionCamelCase" } } } }, "Layout_FollowAutoLayoutTypeCamelCase": { "type": "string", "enum": [ "FILL", "FIXED" ] }, "ZoneMetaCamelCase": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" } } }, "FlowchartTypeCamelCase": { "type": "string", "enum": [ "FLOWCHART_TYPE_UNSPECIFIED", "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" ] }, "FillCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "noFill", "solid", "gradient", "picture" ], "name": "fill_type" } ], "properties": { "solid": { "$ref": "#/components/schemas/Fill_SolidFillCamelCase" }, "noFill": { "$ref": "#/components/schemas/Fill_NoFillCamelCase" }, "gradient": { "$ref": "#/components/schemas/Fill_GradientFillCamelCase" }, "alpha": { "format": "float", "type": "string" }, "picture": { "$ref": "#/components/schemas/Fill_PictureFillCamelCase" } } }, "Fill_GradientFill_LinearGeometry": { "type": "object", "properties": { "start": { "$ref": "#/components/schemas/Point" }, "end": { "$ref": "#/components/schemas/Point" } } }, "GetOperationResultCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "space", "zone", "frame", "zoneSlot", "object", "objectFacetData" ], "name": "result" } ], "properties": { "zoneSlot": { "$ref": "#/components/schemas/Zone_ZoneObjectSlotCamelCase" }, "zone": { "$ref": "#/components/schemas/ZoneCamelCase" }, "objectFacetData": { "$ref": "#/components/schemas/ObjectFacetDataCamelCase" }, "operationId": { "type": "string" }, "requestedOpKind": { "$ref": "#/components/schemas/GetOperationKindCamelCase" }, "error": { "$ref": "#/components/schemas/DataErrorCamelCase" }, "space": { "$ref": "#/components/schemas/SpaceCamelCase" }, "frame": { "$ref": "#/components/schemas/FrameCamelCase" }, "object": { "$ref": "#/components/schemas/VaniGraphicObjectCamelCase" } } }, "Shape_BlockArrow_CurvedArrowCamelCase": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowTypeCamelCase" } } }, "Table_TableRow": { "type": "object", "properties": { "cells": { "type": "array", "items": { "$ref": "#/components/schemas/Table_TableRow_TableCell" } }, "id": { "type": "string" }, "height": { "format": "float", "type": "string" } } }, "Connector_EndpointCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "side", "point" ], "name": "attach" } ], "properties": { "side": { "$ref": "#/components/schemas/Connector_ConnectionSideCamelCase" }, "shapeId": { "type": "string" }, "marker": { "$ref": "#/components/schemas/Connector_MarkerTypeCamelCase" }, "point": { "$ref": "#/components/schemas/PointCamelCase" } } }, "ComparisonOp": { "type": "string", "enum": [ "COMPARISON_OP_UNSPECIFIED", "EQ", "NEQ", "GT", "GTE", "LT", "LTE" ] }, "ArcTo": { "type": "object", "properties": { "x_radius": { "format": "float", "type": "string" }, "y_radius": { "format": "float", "type": "string" }, "start_angle": { "format": "float", "type": "string" }, "sweep_angle": { "format": "float", "type": "string" }, "end": { "$ref": "#/components/schemas/Point" } } }, "Chart_BubbleChart_BubbleSizeCamelCase": { "type": "object", "properties": { "scale": { "format": "float", "type": "string" }, "represent": { "$ref": "#/components/schemas/Chart_BubbleChart_BubbleSize_RepresentBubbleSizeCamelCase" } } }, "Connector_ConnectionSideCamelCase": { "type": "string", "enum": [ "UNKNOWN_SIDE", "NORTH", "EAST", "SOUTH", "WEST" ] }, "DomainDiagram_DiagramConnectorCamelCase": { "type": "object", "properties": { "connector": { "$ref": "#/components/schemas/ConnectorCamelCase" }, "id": { "type": "string" } } }, "DomainDiagram_DiagramTypeCamelCase": { "type": "string", "enum": [ "UML", "DFD", "ERD" ] }, "Layout_Constraints_VerticalConstraint": { "type": "string", "enum": [ "TOP", "BOTTOM", "MIDDLE", "TOP_BOTTOM", "VERTICAL_SCALE" ] }, "Chart_Grouping": { "type": "string", "enum": [ "CLUSTERED", "STACKED", "PERCENT_STACKED" ] }, "Stroke_CapTypeCamelCase": { "type": "string", "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "SmoothCubicTo": { "type": "object", "properties": { "control2": { "$ref": "#/components/schemas/Point" }, "end": { "$ref": "#/components/schemas/Point" } } }, "PictureCamelCase": { "type": "object", "properties": { "media": { "$ref": "#/components/schemas/AssetRefCamelCase" }, "filters": { "$ref": "#/components/schemas/PictureFiltersCamelCase" }, "properties": { "$ref": "#/components/schemas/GraphicObjectPropertiesCamelCase" } } }, "TextPropertiesCamelCase": { "type": "object", "properties": { "inset": { "$ref": "#/components/schemas/TextProperties_MarginCamelCase" }, "paraStyle": { "$ref": "#/components/schemas/ParaStyleCamelCase" }, "valign": { "$ref": "#/components/schemas/VerticalAlignTypeCamelCase" }, "autoFit": { "$ref": "#/components/schemas/TextProperties_TextBoxAutoFitCamelCase" }, "textStyle": { "$ref": "#/components/schemas/AssetRefCamelCase" } } }, "PictureFilters": { "type": "object", "properties": { "brightness": { "format": "float", "type": "string" }, "color_mode": { "$ref": "#/components/schemas/PictureFilters_ColorMode" }, "contrast": { "format": "float", "type": "string" } } }, "Shape_Callout": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CalloutType" } } }, "DatabaseValue_RelationValueCamelCase": { "type": "object", "properties": { "rowIds": { "type": "array", "items": { "type": "string" } } } }, "DatabaseValue_RelationValue": { "type": "object", "properties": { "row_ids": { "type": "array", "items": { "type": "string" } } } }, "Shape_BlockArrow_ArrowTypeCamelCase": { "type": "string", "enum": [ "RIGHT", "LEFT", "TOP", "BOTTOM" ] }, "SmoothQuadraticToCamelCase": { "type": "object", "properties": { "end": { "$ref": "#/components/schemas/PointCamelCase" } } }, "DomainDiagram_UmlDiagram": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramConnector" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_UmlNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramEdge" } } } }, "Structure_Spacing_SpacingTypeCamelCase": { "type": "string", "enum": [ "AUTO", "MANUAL" ] }, "InsertZoneSlotOp": { "type": "object", "properties": { "zone_id": { "type": "string" }, "insert_index": { "format": "int32", "type": "string" }, "zone_slot": { "$ref": "#/components/schemas/Zone_ZoneObjectSlot" } } }, "Stroke_CapType": { "type": "string", "enum": [ "FLAT", "CAPROUND", "SQUARE" ] }, "StrokeCamelCase": { "type": "object", "properties": { "captype": { "$ref": "#/components/schemas/Stroke_CapTypeCamelCase" }, "jointype": { "$ref": "#/components/schemas/Stroke_JoinTypeCamelCase" }, "width": { "format": "float", "type": "string" }, "position": { "$ref": "#/components/schemas/Stroke_StrokePositionCamelCase" }, "type": { "$ref": "#/components/schemas/Stroke_StrokeTypeCamelCase" }, "fill": { "$ref": "#/components/schemas/FillCamelCase" }, "dashPattern": { "type": "array", "items": { "format": "float", "type": "string" } } } }, "VaniGraphicObject_StickyNote_StickyNoteType": { "type": "string", "enum": [ "STICKY_NOTE_TYPE_UNSPECIFIED", "ARROW", "FLAG", "RING", "PLAIN", "CLIP", "PIN", "FOLDED" ] }, "DatabaseTable_ColumnType": { "type": "string", "enum": [ "TEXT", "NUMBER", "TOGGLE", "CHECKBOX", "SELECT", "MULTI_SELECT", "CATEGORY", "DATE", "PERSON", "PHONE", "EMAIL", "URL", "RATING", "RELATION", "LOOKUP", "ROLLUP" ] }, "CustomShapeCamelCase": { "type": "object", "properties": { "paths": { "type": "array", "items": { "$ref": "#/components/schemas/PathCamelCase" } }, "width": { "format": "float", "type": "string" }, "height": { "format": "float", "type": "string" } } }, "PathCommandCamelCase": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "moveTo", "lineTo", "cubicTo", "quadraticTo", "arcTo", "smoothCubicTo", "smoothQuadraticTo", "closePath" ], "name": "command" } ], "properties": { "arcTo": { "$ref": "#/components/schemas/ArcToCamelCase" }, "cubicTo": { "$ref": "#/components/schemas/CubicToCamelCase" }, "quadraticTo": { "$ref": "#/components/schemas/QuadraticToCamelCase" }, "smoothQuadraticTo": { "$ref": "#/components/schemas/SmoothQuadraticToCamelCase" }, "closePath": { "$ref": "#/components/schemas/ClosePathCamelCase" }, "lineTo": { "$ref": "#/components/schemas/LineToCamelCase" }, "smoothCubicTo": { "$ref": "#/components/schemas/SmoothCubicToCamelCase" }, "moveTo": { "$ref": "#/components/schemas/MoveToCamelCase" } } }, "Connector_ConnectedShapeCamelCase": { "type": "object", "properties": { "first": { "$ref": "#/components/schemas/Connector_EndpointCamelCase" }, "second": { "$ref": "#/components/schemas/Connector_EndpointCamelCase" } } }, "Fill_GradientFill_LinearGeometryCamelCase": { "type": "object", "properties": { "start": { "$ref": "#/components/schemas/PointCamelCase" }, "end": { "$ref": "#/components/schemas/PointCamelCase" } } }, "Fill_GradientFill_Stop": { "type": "object", "properties": { "color": { "$ref": "#/components/schemas/Color" }, "position": { "format": "float", "type": "string" } } }, "VaniGraphicObject_GroupShape": { "type": "object", "properties": { "layout": { "$ref": "#/components/schemas/Layout" }, "auto_layout": { "$ref": "#/components/schemas/AutoLayout" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/VaniGraphicObject_GroupShape_GroupObject" } } } }, "PictureFilters_ColorMode_Bilevel": { "type": "object", "properties": { "level": { "format": "float", "type": "string" } } }, "Shape_StarCamelCase": { "type": "object", "properties": { "ribbon": { "$ref": "#/components/schemas/Shape_Star_RibbonCamelCase" }, "scroll": { "$ref": "#/components/schemas/Shape_Star_ScrollCamelCase" }, "type": { "$ref": "#/components/schemas/StarTypeCamelCase" }, "point": { "$ref": "#/components/schemas/Shape_Star_PointCamelCase" }, "wave": { "$ref": "#/components/schemas/Shape_Star_WaveCamelCase" } } }, "InsertFrameOp": { "type": "object", "properties": { "zone_id": { "type": "string" }, "frame": { "$ref": "#/components/schemas/Frame" } } }, "PictureFilters_ColorMode": { "type": "object", "x-vani-oneof-groups": [ { "members": [ "gray_scale", "bilevel", "sepia", "duotone" ], "name": "mode" } ], "properties": { "sepia": { "$ref": "#/components/schemas/PictureFilters_ColorMode_Sepia" }, "gray_scale": { "$ref": "#/components/schemas/PictureFilters_ColorMode_GrayScale" }, "duotone": { "$ref": "#/components/schemas/PictureFilters_ColorMode_Duotone" }, "bilevel": { "$ref": "#/components/schemas/PictureFilters_ColorMode_Bilevel" } } }, "Zone": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/ZoneMeta" }, "objects": { "type": "array", "items": { "$ref": "#/components/schemas/Zone_ZoneObjectSlot" } } } }, "Chart_ChartTitle": { "type": "object", "properties": { "title": { "type": "string" } } }, "DomainDiagram_ErdDiagram": { "type": "object", "properties": { "connectors": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramConnector" } }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_ErdNode" } }, "edges": { "type": "array", "items": { "$ref": "#/components/schemas/DomainDiagram_DiagramEdge" } } } }, "Color_HexColorCamelCase": { "type": "object", "properties": { "value": { "type": "string" } } }, "InsertObjectOp": { "type": "object", "properties": { "container": { "$ref": "#/components/schemas/ObjectContainerRef" }, "insert_index": { "format": "int32", "type": "string" }, "object": { "$ref": "#/components/schemas/VaniGraphicObject" } } }, "Shape_BlockArrowCamelCase": { "type": "object", "properties": { "singleArrow": { "$ref": "#/components/schemas/Shape_BlockArrow_SingleArrowCamelCase" }, "doubleArrow": { "$ref": "#/components/schemas/Shape_BlockArrow_DoubleArrowCamelCase" }, "arrowCallout": { "$ref": "#/components/schemas/Shape_BlockArrow_ArrowCalloutCamelCase" }, "type": { "$ref": "#/components/schemas/BlockArrowTypeCamelCase" }, "curvedArrow": { "$ref": "#/components/schemas/Shape_BlockArrow_CurvedArrowCamelCase" } } }, "DatabaseTableView_GridFormCamelCase": { "type": "object", "properties": {} }, "Shape_MathematicalSymbol": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MathematicalSymbolType" } } }, "MoveTo": { "type": "object", "properties": { "point": { "$ref": "#/components/schemas/Point" } } }, "Shape_Basic_SnipRectangle_SnipRectangleTypeCamelCase": { "type": "string", "enum": [ "SNIP_SINGLE", "SNIP_SAME_SIDE", "SNIP_DIAGONAL" ] }, "UpdateZoneMetaOp": { "type": "object", "properties": { "zone_id": { "type": "string" }, "zone_meta": { "$ref": "#/components/schemas/ZoneMeta" }, "update_mask": { "$ref": "#/components/schemas/FieldMask" } } }, "Color_HSBColorCamelCase": { "type": "object", "properties": { "saturation": { "format": "float", "type": "string" }, "brightness": { "format": "float", "type": "string" }, "hue": { "format": "float", "type": "string" } } }, "Fill_GradientFillCamelCase": { "type": "object", "properties": { "linear": { "$ref": "#/components/schemas/Fill_GradientFill_LinearGeometryCamelCase" }, "radialAngular": { "$ref": "#/components/schemas/Fill_GradientFill_RadialAngularGeometryCamelCase" }, "stops": { "type": "array", "items": { "$ref": "#/components/schemas/Fill_GradientFill_StopCamelCase" } }, "type": { "$ref": "#/components/schemas/Fill_GradientFill_GradientFillTypeCamelCase" } } }, "QuadraticToCamelCase": { "type": "object", "properties": { "control": { "$ref": "#/components/schemas/PointCamelCase" }, "end": { "$ref": "#/components/schemas/PointCamelCase" } } }, "Chart_ChartAxis_AxisCross_CrossAt_AutoCrossCamelCase": { "type": "string", "enum": [ "ZERO", "MIN", "MAX" ] }, "Shape_Star_Wave": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/Shape_Star_Wave_WaveType" } } } }, "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" } }, "responses": { "RateLimitExceededThisOperationAllows30Re": { "description": "Rate limit exceeded - this operation allows 30 requests per minute per user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "RateLimitExceededThisOperationAllows10Re": { "description": "Rate limit exceeded - this operation allows 10 requests per minute per user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "InvalidRequestValidationFailed": { "description": "Invalid request - validation failed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "RateLimitExceededThisOperationAllows500R": { "description": "Rate limit exceeded - this operation allows 500 requests per minute per user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "RateLimitExceededThisOperationAllows60Re": { "description": "Rate limit exceeded - this operation allows 60 requests per minute per user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "NotFoundAResourceNamedInThePathDoesNotEx10": { "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" } } } }, "InternalServerErrorTheRequestWasWellForm": { "description": "Internal server error - the request was well-formed but could not be completed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "UnauthorizedMissingOrInvalidAccessToken9": { "description": "Unauthorized - missing or invalid access token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } }, "SuccessfulResponse": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniEnvelope" } } } }, "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" } } } } } }, "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" } } } } } }, "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" } } } } } }, "SuccessfulResponse2": { "description": "Successful response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/VaniEnvelope" }, { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeleteColumnsResponse" } } } ] } } } }, "RateLimitExceededThisOperationAllows120R": { "description": "Rate limit exceeded - this operation allows 120 requests per minute per user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VaniError" } } } } }, "parameters": { "EditionId": { "schema": { "type": "string" }, "in": "path", "name": "edition_id", "description": "The unique identifier of the edition", "required": true }, "Fields2": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "id", "description", "name", "is_available_for_edition" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: id, description, name, is_available_for_edition", "required": false }, "From": { "schema": { "pattern": "^[0-9]{1,6}$", "type": "string", "maxLength": 6 }, "in": "query", "name": "from", "description": "The starting index from where the results should be fetched. Default value is 0", "required": false }, "Limit": { "schema": { "pattern": "^[1-9][0-9]{0,2}$", "type": "string", "maxLength": 3 }, "in": "query", "name": "limit", "description": "The maximum number of results to return in the response. Default value is 20", "required": false }, "Fields7": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "state", "created_time", "last_modified_time", "edition_type_name", "edition_name", "edition_role_name", "edition_id", "edition_owner_id", "is_default", "uri" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: state, created_time, last_modified_time, edition_type_name, edition_name, edition_role_name, edition_id, edition_owner_id, is_default, uri", "required": false }, "RequestId": { "schema": { "type": "string" }, "in": "path", "name": "request_id", "description": "The unique identifier of the request", "required": true }, "Roles": { "schema": { "x-enumDescriptions": { "TEAM_GUEST": "A guest with limited access to the team.", "TEAM_ADMIN": "Can administer the team, including its members.", "MEMBER": "A regular member of the team." }, "type": "string", "enum": [ "TEAM_ADMIN", "MEMBER", "TEAM_GUEST" ] }, "in": "query", "name": "roles", "description": "Parameter: roles. Allowed values: TEAM_ADMIN, MEMBER, TEAM_GUEST", "required": false }, "TeamId": { "schema": { "type": "string" }, "in": "path", "name": "team_id", "description": "The unique identifier of the team", "required": true }, "SubscriberState": { "schema": { "x-enumDescriptions": { "ACTIVE": "Members currently occupying a subscription seat.", "INACTIVE": "Members not occupying a subscription seat." }, "type": "string", "enum": [ "ACTIVE", "INACTIVE" ] }, "in": "query", "name": "subscriber_state", "description": "Parameter: subscriber_state. Allowed values: ACTIVE, INACTIVE", "required": false }, "MemberId": { "schema": { "type": "string" }, "in": "path", "name": "member_id", "description": "The unique identifier of the member", "required": true }, "Fields": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "created_by", "created_by_name", "created_time", "team_member_count", "zsoid", "team_name", "team_id", "uri" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: created_by, created_by_name, created_time, team_member_count, zsoid, team_name, team_id, uri", "required": false }, "UserId": { "schema": { "type": "string" }, "in": "path", "name": "user_id", "description": "The unique identifier of the user", "required": true }, "Search": { "schema": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "type": "string", "maxLength": 100 }, "in": "query", "name": "search", "description": "The keyword or phrase to search for", "required": false }, "Fields3": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "requested_time", "requested_by", "name", "request_id", "status" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: requested_time, requested_by, name, request_id, status", "required": false }, "Fields8": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "zuid", "role_name", "added_time", "added_by", "modified_time", "display_name", "mail_id", "edition_id", "team_id", "invited_time" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: zuid, role_name, added_time, added_by, modified_time, display_name, mail_id, edition_id, team_id, invited_time", "required": false }, "SpaceId": { "schema": { "type": "string" }, "in": "path", "name": "space_id", "description": "The unique identifier of the space", "required": true }, "Fields4": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "requested_time", "requested_by", "name", "request_id", "status", "role" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: requested_time, requested_by, name, request_id, status, role", "required": false }, "Fields6": { "schema": { "type": "string", "maxLength": 1000, "enum": [ "space_name", "space_id", "owner_zuid", "team_id", "last_author_zuid", "created_time", "last_modified_time", "last_saved_version", "publish", "published_version_id", "last_published_time", "thumb_image_id", "client_import_id", "is_private_space", "file_size", "allow_embed", "status", "can_edit", "is_favorite", "space_member_count", "state_modified_time", "uri", "open_url" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_name, space_id, owner_zuid, team_id, last_author_zuid, created_time, last_modified_time, last_saved_version, publish, published_version_id, last_published_time, thumb_image_id, client_import_id, is_private_space, file_size, allow_embed, status, can_edit, is_favorite, space_member_count, state_modified_time, uri, open_url", "required": false }, "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 }, "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 }, "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 }, "Search2": { "schema": { "pattern": "^(?:[0-9a-zA-Z_~`#%&\\^\\*\\(\\)\\{\\}\\[\\]\\+\\*\\|=\\-\\.\\$@\\?,:;>\\\\'\\/!\\u0080-\\uFFFF\\s<\"]+)$", "type": "string", "maxLength": 100 }, "in": "query", "name": "search", "description": "The keyword or phrase to search for", "required": true }, "Fields5": { "schema": { "type": "string", "enum": [ "space_id", "position", "shared_by", "permission", "share_type", "is_password_enabled", "password", "expiration_time", "shared_time", "external_share_url", "zone_ids", "link_name" ] }, "in": "query", "name": "fields", "description": "Specifies the fields (comma-separated) to retrieve. Allowed values: space_id, position, shared_by, permission, share_type, is_password_enabled, password, expiration_time, shared_time, external_share_url, zone_ids, link_name", "required": false }, "RevisionId": { "schema": { "pattern": "^(?:-?[0-9]+)$", "type": "string", "maxLength": 200 }, "in": "query", "name": "revision_id", "description": "Optional: specific revision to fetch; latest if empty", "required": false } } } }