{ "info": { "_postman_id": "c34e6898-1196-4bd4-b393-a59df586675f", "name": "Visio JavaScript Application Shapes API", "description": "The Visio JavaScript API enables building Office Add-ins that interact with Visio diagrams embedded in classic SharePoint Online pages. The API provides access to document elements including pages, shapes, hyperlinks, comments, shape data items, and shape views. Developers can create visual overlays, register mouse event handlers, read shape text and shape data, and control application settings. The API uses a request context and proxy object pattern with batch execution via Visio.run() and context.sync().\n\nContact Support:\n Name: Microsoft Office Dev\n Email: officedevfeedback@microsoft.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "lastUpdatedBy": "35240", "uid": "35240-c34e6898-1196-4bd4-b393-a59df586675f" }, "item": [ { "name": "document", "item": [ { "name": "pages", "item": [ { "name": "{pageName}", "item": [ { "name": "shapes", "item": [ { "name": "{shapeId}", "item": [ { "name": "view", "item": [ { "name": "Update Shape View", "id": "d9df3b44-3d41-4c1c-a519-34ab6cb00d10", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId/view", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId", "view" ], "variable": [ { "id": "5a821128-ecc3-4697-ac0c-5d301d6e33ee", "key": "pageName", "value": "", "description": "(Required) Name of the Visio page" }, { "id": "3dd34b3d-4395-4963-8938-b262e2ac1b96", "key": "shapeId", "value": "", "description": "(Required) Numeric ID of the shape" } ] }, "description": "Updates the visual presentation of a shape, including highlight color, tooltip text, and overlay content for the specified shape." }, "response": [ { "id": "d5130173-39f9-4b51-908d-15ecc631bae2", "name": "Updated shape view", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId/view", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId", "view" ], "variable": [ { "key": "pageName" }, { "key": "shapeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n}", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-d5130173-39f9-4b51-908d-15ecc631bae2" }, { "id": "44bfbdce-dbe9-4eb0-861d-bec04e0254ee", "name": "Shape not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId/view", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId", "view" ], "variable": [ { "key": "pageName" }, { "key": "shapeId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-44bfbdce-dbe9-4eb0-861d-bec04e0254ee" }, { "id": "76b9046f-2925-4b28-aa37-a8049663f196", "name": "Internal server error", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId/view", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId", "view" ], "variable": [ { "key": "pageName" }, { "key": "shapeId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-76b9046f-2925-4b28-aa37-a8049663f196" } ], "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-d9df3b44-3d41-4c1c-a519-34ab6cb00d10" } ], "id": "cd77385d-fc54-4fec-be2f-e923abdbb9e9", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-cd77385d-fc54-4fec-be2f-e923abdbb9e9" }, { "name": "Get Shape", "id": "1a3c3e8d-a7ea-4576-b914-ca9f60ea751b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId" ], "variable": [ { "id": "0faa1e94-d336-4a5c-82a5-03edc42526fc", "key": "pageName", "value": "", "description": "(Required) Name of the Visio page" }, { "id": "cda800c5-a4a9-4f91-85ab-75093e8465b2", "key": "shapeId", "value": "", "description": "(Required) Numeric ID of the shape" } ] }, "description": "Returns a specific shape on the Visio page identified by its shape ID. Includes shape text, data items, hyperlinks, and visual view properties." }, "response": [ { "id": "09defccf-7f6b-4462-aab2-67961a27f435", "name": "Shape object", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId" ], "variable": [ { "key": "pageName" }, { "key": "shapeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"text\": \"\",\n \"select\": \"\",\n \"view\": {\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n },\n \"shapeDataItems\": {\n \"items\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"format\": \"\",\n \"formattedValue\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"format\": \"\",\n \"formattedValue\": \"\"\n }\n ]\n },\n \"hyperlinks\": {\n \"items\": [\n {\n \"address\": \"\",\n \"description\": \"\",\n \"subAddress\": \"\",\n \"extraInfo\": \"\"\n },\n {\n \"address\": \"\",\n \"description\": \"\",\n \"subAddress\": \"\",\n \"extraInfo\": \"\"\n }\n ]\n },\n \"comments\": {\n \"items\": [\n {\n \"author\": \"\",\n \"date\": \"\",\n \"text\": \"\"\n },\n {\n \"author\": \"\",\n \"date\": \"\",\n \"text\": \"\"\n }\n ]\n },\n \"boundingBox\": {\n \"x\": \"\",\n \"y\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n}", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-09defccf-7f6b-4462-aab2-67961a27f435" }, { "id": "762339d2-9713-47f3-895f-f1dba10ac53a", "name": "Shape not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId" ], "variable": [ { "key": "pageName" }, { "key": "shapeId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-762339d2-9713-47f3-895f-f1dba10ac53a" }, { "id": "825b8389-131f-4381-a2f8-034c69149950", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes/:shapeId", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes", ":shapeId" ], "variable": [ { "key": "pageName" }, { "key": "shapeId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-825b8389-131f-4381-a2f8-034c69149950" } ], "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-1a3c3e8d-a7ea-4576-b914-ca9f60ea751b" } ], "id": "bb518941-ff63-473d-8921-70fc0879bbfc", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-bb518941-ff63-473d-8921-70fc0879bbfc" }, { "name": "List Shapes", "id": "693962fa-0dad-4fe5-ae3c-9492d3e773a9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes" ], "variable": [ { "id": "02bc1e83-2666-4557-9104-fa12c3722084", "key": "pageName", "value": "", "description": "(Required) Name of the Visio page" } ] }, "description": "Returns all shapes on the specified Visio page. Each shape includes its name, text, ID, selection state, bounding box, and associated data." }, "response": [ { "id": "82e42d7f-20ed-47e8-848e-0f5fe63ffc72", "name": "Collection of shapes", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes" ], "variable": [ { "key": "pageName" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"text\": \"\",\n \"select\": \"\",\n \"view\": {\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n },\n \"shapeDataItems\": {\n \"items\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"format\": \"\",\n \"formattedValue\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"format\": \"\",\n \"formattedValue\": \"\"\n }\n ]\n },\n \"hyperlinks\": {\n \"items\": [\n {\n \"address\": \"\",\n \"description\": \"\",\n \"subAddress\": \"\",\n \"extraInfo\": \"\"\n },\n {\n \"address\": \"\",\n \"description\": \"\",\n \"subAddress\": \"\",\n \"extraInfo\": \"\"\n }\n ]\n },\n \"comments\": {\n \"items\": [\n {\n \"author\": \"\",\n \"date\": \"\",\n \"text\": \"\"\n },\n {\n \"author\": \"\",\n \"date\": \"\",\n \"text\": \"\"\n }\n ]\n },\n \"boundingBox\": {\n \"x\": \"\",\n \"y\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"text\": \"\",\n \"select\": \"\",\n \"view\": {\n \"highlight\": {\n \"color\": \"\",\n \"width\": \"\"\n },\n \"tooltip\": \"\"\n },\n \"shapeDataItems\": {\n \"items\": [\n {\n \"label\": \"\",\n \"value\": \"\",\n \"format\": \"\",\n \"formattedValue\": \"\"\n },\n {\n \"label\": \"\",\n \"value\": \"\",\n \"format\": \"\",\n \"formattedValue\": \"\"\n }\n ]\n },\n \"hyperlinks\": {\n \"items\": [\n {\n \"address\": \"\",\n \"description\": \"\",\n \"subAddress\": \"\",\n \"extraInfo\": \"\"\n },\n {\n \"address\": \"\",\n \"description\": \"\",\n \"subAddress\": \"\",\n \"extraInfo\": \"\"\n }\n ]\n },\n \"comments\": {\n \"items\": [\n {\n \"author\": \"\",\n \"date\": \"\",\n \"text\": \"\"\n },\n {\n \"author\": \"\",\n \"date\": \"\",\n \"text\": \"\"\n }\n ]\n },\n \"boundingBox\": {\n \"x\": \"\",\n \"y\": \"\",\n \"width\": \"\",\n \"height\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-82e42d7f-20ed-47e8-848e-0f5fe63ffc72" }, { "id": "0a2740b4-cc63-4574-a4d5-9f984d494fa0", "name": "Page not found", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes" ], "variable": [ { "key": "pageName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-0a2740b4-cc63-4574-a4d5-9f984d494fa0" }, { "id": "b8daa59b-3cb9-4819-b001-cadb982ac0e9", "name": "Internal server error", "originalRequest": { "method": "GET", "header": [ { "description": "Added as a part of security scheme: apikey", "key": "X-Embedded-Session", "value": "" } ], "url": { "raw": "{{baseUrl}}/document/pages/:pageName/shapes", "host": [ "{{baseUrl}}" ], "path": [ "document", "pages", ":pageName", "shapes" ], "variable": [ { "key": "pageName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-b8daa59b-3cb9-4819-b001-cadb982ac0e9" } ], "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-693962fa-0dad-4fe5-ae3c-9492d3e773a9" } ], "id": "056d4e19-3ad9-4c33-8332-21bb157cd3f8", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-056d4e19-3ad9-4c33-8332-21bb157cd3f8" } ], "id": "93856a3f-bdbb-4841-9376-60d838f44112", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-93856a3f-bdbb-4841-9376-60d838f44112" } ], "id": "e34074fb-494c-4dd9-a276-d5436b15e2f0", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-e34074fb-494c-4dd9-a276-d5436b15e2f0" } ], "id": "55b5e845-f9a4-4c08-8be8-e4f1b64a3cdc", "createdAt": "2026-07-28T03:27:44.000Z", "updatedAt": "2026-07-28T03:27:44.000Z", "uid": "35240-55b5e845-f9a4-4c08-8be8-e4f1b64a3cdc" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-Embedded-Session", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://appsforoffice.microsoft.com/embedded/1.0" } ] }