{"info":{"_postman_id":"87f246cd-cbb5-4be4-a269-b8fa6d5adfef","name":"Vertex Platform API","description":"

The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application.

\n

See our Developer Guides to get started.

\n

Notes about the Postman collection and API Reference code samples:

\n\n

Email: support@vertex3d.com

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"19169840","collectionId":"87f246cd-cbb5-4be4-a269-b8fa6d5adfef","publishedId":"2sBY4Jw2qK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-08-10T18:17:45.000Z"},"item":[{"name":"accounts","item":[{"name":"create Account","id":"v-create-account","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts","description":"

Create an account.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateAccountRequest_datatrue
▹ attributesCreateAccountRequest_data_attributestrue
▹▹ namestringtrue
▹ typestringtrue
\n
","urlObject":{"path":["accounts"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"9f732e6e-afe2-4705-9a35-38372c47fb90","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"175805c3-069c-49c8-818e-a0b81c08c1f9","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"40f963a9-0879-4687-bf69-9b19616a7367","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0d164b84-e9ac-4dc0-b97c-48a7eb9856e4","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-account"},{"name":"delete Account","id":"v-delete-account","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/accounts/:id","description":"

Delete an account.

\n","urlObject":{"path":["accounts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The account ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dc93ab7c-745d-47f2-943a-1dc776df7548","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"adc2b1cb-95f6-4263-bbdd-3610674607d7","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"8a07f9f4-4a10-4763-b2ed-07e6f65dbea2","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ae95cae9-0218-42d6-ae95-bcbd47358540","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-account"},{"name":"get Account","id":"v-get-account","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/accounts/:id","description":"

Get an account.

\n","urlObject":{"path":["accounts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The account ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9b387e60-893a-42e6-8cd7-ffdf5df8e2fe","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"57932bd1-0640-4fde-bde1-4fff90be3681","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5ec12586-7378-49ee-96f8-eb54ecf7ac64","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"90fe9e5c-9c84-4cf0-b2db-8c37403a412f","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-account"},{"name":"update Account","id":"v-update-account","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts/:id","description":"

Update an account.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateAccountRequest_datatrue
▹ attributesUpdateAccountRequest_data_attributestrue
▹▹ namestringfalse
▹▹ ownerstringfalse
▹▹ statusenum(active, disabled)false
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["accounts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The account ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e8e2193f-f526-48ba-9366-6a7a5aa255cb","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8fb2cfe9-d09b-4b6d-aeb2-a15beaeddbb1","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3176537f-3648-47bc-8f2b-964b57117806","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"923fbcb5-4d9a-4aa1-9314-33f3da3ff035","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"58ac5f02-0127-4e3b-afd5-5c210635e984","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-account"},{"name":"create Application For Account","id":"v-create-application-for-account","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts/:id/applications","description":"

Create an application for an account.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataAdminCreateApplicationRequest_datatrue
▹ attributesAdminCreateApplicationRequest_data_attributestrue
▹▹ namestringtrue
▹▹ redirect_uris[NonEmptyString]false
▹▹ scopes[NonEmptyString]false
▹ typestringtrue
\n
","urlObject":{"path":["accounts",":id","applications"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The account ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8be9e0f2-fe5f-4748-a52e-5f47531396f1","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id/applications","host":["https://platform.vertexvis.com"],"path":["accounts",":id","applications"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}"},{"id":"6e097a80-a494-4cd9-a6cc-e4df29e8dccf","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id/applications","host":["https://platform.vertexvis.com"],"path":["accounts",":id","applications"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ad01ca9f-8924-4edd-8c21-afa70f78918a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id/applications","host":["https://platform.vertexvis.com"],"path":["accounts",":id","applications"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9ffff879-0ed8-4323-aaea-90329fbc460c","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id/applications","host":["https://platform.vertexvis.com"],"path":["accounts",":id","applications"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"dbc3b58f-9eb8-4955-8024-3bc006dd2de3","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id/applications","host":["https://platform.vertexvis.com"],"path":["accounts",":id","applications"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-application-for-account"}],"id":"v-accounts","_postman_id":"v-accounts","description":""},{"name":"applications","item":[{"name":"get Applications","id":"v-get-applications","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/applications?page[cursor]=&page[size]=&filter[clientId]=","description":"

Get applications.

\n","urlObject":{"path":["applications"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of client IDs to filter on.

\n","type":"text/plain"},"key":"filter[clientId]","value":""}],"variable":[]}},"response":[{"id":"a48e7615-4c5e-4271-a7fe-fbfd086832f9","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications?page[cursor]=&page[size]=&filter[clientId]=","host":["https://platform.vertexvis.com"],"path":["applications"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of client IDs to filter on.","key":"filter[clientId]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"cd0dd984-75cd-4480-8c49-e631c393f526","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications?page[cursor]=&page[size]=&filter[clientId]=","host":["https://platform.vertexvis.com"],"path":["applications"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of client IDs to filter on.","key":"filter[clientId]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4f630070-57e3-4cab-8cb1-1da73178c06e","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications?page[cursor]=&page[size]=&filter[clientId]=","host":["https://platform.vertexvis.com"],"path":["applications"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of client IDs to filter on.","key":"filter[clientId]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-applications"},{"name":"create Application","id":"v-create-application","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications","description":"

Create an OAuth2 application.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateAccountRequest_datatrue
▹ attributesCreateAccountRequest_data_attributestrue
▹▹ namestringtrue
▹ typestringtrue
\n
","urlObject":{"path":["applications"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"75e85623-3caa-415e-ba5b-1b0ed0ee8999","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}"},{"id":"b8dec821-4288-400d-8880-87e2a6120ce3","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"98ee07f5-1ab0-4e84-a08e-39c94e597d58","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9d5b15c6-3962-4451-a224-b6050bb33b34","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-application"},{"name":"delete Application","id":"v-delete-application","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/applications/:id","description":"

Delete an application.

\n","urlObject":{"path":["applications",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The application ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"410a5365-4ae4-40e5-9bf3-05581f1d257b","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b271c42c-9dd7-427a-a659-7f08a790f204","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3ead7701-f672-45f5-aaa4-4cfdfa926756","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"61d5b6b4-ab0e-4003-b23d-38d36f145ed9","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-application"},{"name":"get Application","id":"v-get-application","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/applications/:id","description":"

Get an application.

\n","urlObject":{"path":["applications",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The application ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"da97d7da-1ff5-41eb-9c23-eea46dd4930f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"bd4076de-d780-4f1c-945a-f734f37ef660","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"83cdaf6a-bf6b-4251-aa60-ce798ad7df22","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4d5faf2c-2a85-48fd-b6cc-0cc5798838fe","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-application"},{"name":"update Application","id":"v-update-application","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications/:id","description":"

Update an application.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateApplicationRequest_datatrue
▹ attributesUpdateApplicationRequest_data_attributestrue
▹▹ namestringfalse
▹▹ redirect_uris[NonEmptyString]false
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["applications",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The application ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"88921269-e7ac-42da-874d-a3234039d8ea","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"94def0cf-4ffd-400e-a8d0-ae961c0bc631","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f1d1c0d4-fada-4c87-8dae-bb042bdd3fe2","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2b699206-9233-4e40-aa52-eec6a27250f9","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ec12324e-4eea-458e-b07b-3c6a0f850552","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-application"}],"id":"v-applications","_postman_id":"v-applications","description":""},{"name":"attachments","item":[{"name":"list Attachments","id":"v-list-attachments","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/attachments?filter[relationshipId]=&filter[relationshipType]=reply&page[cursor]=&page[size]=","description":"

List attachments\nPreview: This is a preview API and is subject to change.

\n","urlObject":{"path":["attachments"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

(Required) A relationship id to filter attachments for

\n","type":"text/plain"},"key":"filter[relationshipId]","value":""},{"description":{"content":"

(Required) The type of relationship (reply or thread) (This can only be one of thread,reply)

\n","type":"text/plain"},"key":"filter[relationshipType]","value":"reply"},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"2eb4569a-ffc7-45ee-be85-df5132c0c16a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/attachments?filter[relationshipId]=&filter[relationshipType]=reply&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["attachments"],"query":[{"description":"(Required) A relationship id to filter attachments for","key":"filter[relationshipId]","value":""},{"description":"(Required) The type of relationship (reply or thread) (This can only be one of thread,reply)","key":"filter[relationshipType]","value":"reply"},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"content\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"type\": \"file\",\n \"size\": \"\"\n },\n \"thumbnails\": \"string\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"relationship\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"reply\"\n }\n }\n },\n \"type\": \"\"\n },\n {\n \"attributes\": {\n \"content\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"type\": \"file\",\n \"size\": \"\"\n },\n \"thumbnails\": \"string\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"relationship\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"reply\"\n }\n }\n },\n \"type\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5f490c43-cdd2-43a4-b02f-49efc04c8768","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/attachments?filter[relationshipId]=&filter[relationshipType]=reply&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["attachments"],"query":[{"description":"(Required) A relationship id to filter attachments for","key":"filter[relationshipId]","value":""},{"description":"(Required) The type of relationship (reply or thread) (This can only be one of thread,reply)","key":"filter[relationshipType]","value":"reply"},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"10bbbae5-5477-4458-916b-eac895670a3d","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/attachments?filter[relationshipId]=&filter[relationshipType]=reply&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["attachments"],"query":[{"description":"(Required) A relationship id to filter attachments for","key":"filter[relationshipId]","value":""},{"description":"(Required) The type of relationship (reply or thread) (This can only be one of thread,reply)","key":"filter[relationshipType]","value":"reply"},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"461cc291-42d5-45ae-a79e-4520e9a598b8","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/attachments?filter[relationshipId]=&filter[relationshipType]=reply&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["attachments"],"query":[{"description":"(Required) A relationship id to filter attachments for","key":"filter[relationshipId]","value":""},{"description":"(Required) The type of relationship (reply or thread) (This can only be one of thread,reply)","key":"filter[relationshipType]","value":"reply"},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-attachments"},{"name":"create Attachment","id":"v-create-attachment","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"withContent\": {\n \"name\": \"\",\n \"type\": \"file-content\"\n }\n },\n \"relationships\": {\n \"context\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"type\": \"attachment\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments","description":"

Create an attachment for a thread or a reply relationship. The content of the attachment can be a scene-view-state (created or provided), or a file. A file attachment requires the caller to upload the file after the attachment creation using a provided upload url.\nPreview: This is a preview API and is subject to change.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateAttachmentRequest_datatrue
▹ attributesCreateAttachmentRequest_data_attributestrue
▹▹ withContentWithFileContenttrue
▹▹▹ namestringtrueThe name of the file to create
▹▹▹ typeenum(file-content)true
▹ relationshipsCreateAttachmentRequest_data_relationshipstrue
▹▹ contextanytrue
▹▹▹ anonymousWithThreadfalse
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(thread)true
▹▹▹ anonymousWithReplyfalse
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(reply)true
▹ typeenum(attachment)trueResource object type.
\n
","urlObject":{"path":["attachments"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"a0984552-a722-4e17-8a57-e0bc6eebbcff","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"withContent\": {\n \"name\": \"\",\n \"type\": \"file-content\"\n }\n },\n \"relationships\": {\n \"context\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"type\": \"attachment\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"content\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"type\": \"file\",\n \"size\": \"\"\n },\n \"thumbnails\": 7639\n },\n \"id\": \"\",\n \"relationships\": {\n \"relationship\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"12ba8623-3d36-4c07-8f1b-219e79693d59","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"withContent\": {\n \"name\": \"\",\n \"type\": \"file-content\"\n }\n },\n \"relationships\": {\n \"context\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"type\": \"attachment\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"fd8f76cd-269f-4068-992e-91112a937b65","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"withContent\": {\n \"name\": \"\",\n \"type\": \"file-content\"\n }\n },\n \"relationships\": {\n \"context\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"type\": \"attachment\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"990305ef-c042-462b-b97c-c5bf51e7abbe","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"withContent\": {\n \"name\": \"\",\n \"type\": \"file-content\"\n }\n },\n \"relationships\": {\n \"context\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"type\": \"attachment\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-attachment"},{"name":"create Attachment Download Url","id":"v-create-attachment-download-url","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments/:id/download-url","description":"

Create a download url for a file attachment by ID.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateDownloadRequest_datatrue
▹ attributesCreateDownloadRequest_data_attributestrue
▹▹ expiryinteger(int32)falseSpecifies the duration for which this pre-signed request should be valid. After this time has expired, attempting to use the presigned request will fail. (Defaults to 1 hour, max value is 24 hours)
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["attachments",":id","download-url"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The attachment ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4e9d79ab-1e15-43cc-ac9a-10c38747cde2","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/download-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"891988f0-2740-4b82-9c10-2ad3331b3144","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/download-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"1104248c-c988-4b01-9e25-0a95efd2361a","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/download-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e5114ab2-fb25-4e7f-a5cd-4915096e77b6","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/download-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-attachment-download-url"},{"name":"create Attachment Upload Url","id":"v-create-attachment-upload-url","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/attachments/:id/upload-url","description":"

Create an upload url for a file attachment by ID.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateUploadRequest_datatrue
▹ attributesCreateUploadRequest_data_attributestrue
▹▹ expiryinteger(int32)falseSpecifies the duration for which this pre-signed request should be valid for upload. After this time has expired, attempting to use the presigned request will fail. (Defaults to 1 hour, max value is 24 hours)
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["attachments",":id","upload-url"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The attachment ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"015d8f26-25bc-46a2-9dc3-30dd5d4b7dea","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fd3e01a8-e16d-4b2d-9b49-3ebfd51053ef","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3236bb99-6e45-455c-98f9-67e830654e6d","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b743028b-863b-4a86-83dd-aa887b865da5","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-attachment-upload-url"}],"id":"v-attachments","description":"

Requires Engage Module

\n","_postman_id":"v-attachments"},{"name":"batches","item":[{"name":"create Batch","id":"v-create-batch","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"vertexvis/batch:operations\": [\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"as-specified\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/batches","description":"

Create a batch. This API is asynchronous, returning the location of a queued-batch. Check the status via the getQueuedBatch API.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
vertexvis[BatchOperation]falseList of operations to perform as a batch.
▹ dataanytrueOperation's primary data.
▹▹ anonymousCreateSceneItemRequestDatafalse
▹▹▹ attributesCreateSceneItemRequestData_attributestrue
▹▹▹▹ endItembooleanfalseWhether this item is an end item.
▹▹▹▹ experimentalSourceMetadataKeys[string]falseSpecifies which metadata keys should be copied from the source item. Sending null will default to all keys. Sending an empty string will copy none of the sources' metadata. Sending an array of [\"KEY1\", \"KEY2] will include KEY1 and KEY2 from the source in the scene item creation. This is marked experimental since future releases are expected to prevent copying metadata entirely.
▹▹▹▹ materialOverrideColorMaterialfalseColor properties describing how a material looks.
▹▹▹▹▹ ambientColor3trueRGB color.
▹▹▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹ diffuseColor3trueRGB color.
▹▹▹▹▹ emissiveColor3trueRGB color.
▹▹▹▹▹ glossinessinteger(int32)trueGlossiness from 0 to 128.
▹▹▹▹▹ opacityinteger(int32)trueAn opacity value from 0 to 255.
▹▹▹▹▹ specularColor3trueRGB color.
▹▹▹▹ metadataobjectfalseAdditional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
▹▹▹▹▹ additionalPropertiesanyfalse
▹▹▹▹▹▹ anonymousMetadataLongTypefalse
▹▹▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹▹▹ valueinteger(int64)trueA numerical long value.
▹▹▹▹▹▹ anonymousMetadataFloatTypefalse
▹▹▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹▹▹ valuenumber(float)trueA numerical floating-point value.
▹▹▹▹▹▹ anonymousMetadataDateTypefalse
▹▹▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹▹▹ valuestring(date-time)trueA date value.
▹▹▹▹▹▹ anonymousMetadataStringTypefalse
▹▹▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹▹▹ valuestringtrueA string value.
▹▹▹▹▹▹ anonymousMetadataNullTypefalse
▹▹▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹ namestringfalse
▹▹▹▹ ordinalintegerfalseA 0-based index used for defining a consistent ordering amongst sibling scene items.
▹▹▹▹ parentstringfalseOptional ability to specify a parent scene item by scene item supplied ID. For example, an existing ID from a PLM system. This approach is an alternative to providing a specific scene item ID with the relationship parent property.
▹▹▹▹ partInstanceSuppliedIdsAsSuppliedIdsbooleanfalseWhether or not to use part instance supplied IDs as scene item supplied IDs.
▹▹▹▹ phantombooleanfalsePhantom state of the item.
▹▹▹▹ resolutionRuleenum(as-specified, latest-iteration, latest-revision)falseOptional rule to guide the part-revision resolution algorithm in cases where required qualifiers are not explicitly specified by the query. In the case of assembly parts, the resolution rule also applies recursively to the resolution of the child parts.
▹▹▹▹ sourcePartRevisionSuppliedIdfalse
▹▹▹▹▹ suppliedIterationIdstringfalseOptional iteration ID for the revision. For example, a generated version id from a PLM system to a specific revision. Used when a existing revision is modified.
▹▹▹▹▹ suppliedPartIdstringtrueID provided for correlation. For example, an existing ID from a PLM system.
▹▹▹▹▹ suppliedRevisionIdstringtrueID provided for correlation. For example, an existing ID from a PLM system.
▹▹▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹▹▹ transformMatrix4false4x4 affine transformation matrix.
▹▹▹▹▹ r0Vector4true4D vector.
▹▹▹▹▹▹ wnumbertruew value.
▹▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹▹ r1Vector4true4D vector.
▹▹▹▹▹ r2Vector4true4D vector.
▹▹▹▹▹ r3Vector4true4D vector.
▹▹▹▹ visiblebooleanfalseItem visibility.
▹▹▹ relationshipsCreateSceneItemRequestData_relationshipstrue
▹▹▹▹ parentSceneItemRelationshipfalseRelationship to a scene-item.
▹▹▹▹▹ dataSceneItemRelationship_datatrue
▹▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(scene-item)trueResource object type.
▹▹▹▹ referenceTreeSceneItemRelationshipfalseRelationship to a scene-item.
▹▹▹▹ sourceanyfalseRelationship to a geometry-set, part-revision, part-rendition, or scene.
▹▹▹▹▹ anonymousGeometrySetRelationshipfalseRelationship to a geometry-set.
▹▹▹▹▹▹ dataGeometrySetRelationshipDatatrue
▹▹▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹▹▹ typeenum(geometry-set)trueResource object type.
▹▹▹▹▹ anonymousPartRevisionRelationshipfalseRelationship to a part-revision.
▹▹▹▹▹▹ dataPartData_relationships_partRevisionstrue
▹▹▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹▹▹ typeenum(part-revision)trueResource object type.
▹▹▹▹▹ anonymousSceneRelationshipfalseRelationship to a scene.
▹▹▹▹▹▹ dataSceneRelationship_datatrue
▹▹▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹▹▹ typeenum(scene)trueResource object type.
▹▹▹▹▹ anonymousPartRenditionRelationshipfalseRelationship to a part-rendition.
▹▹▹▹▹▹ dataPartRenditionRelationship_datatrue
▹▹▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹▹▹ typeenum(part-rendition)trueResource object type.
▹▹▹ typestringtrueResource object type.
▹▹ anonymousRelationshipDatafalse
▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹ typestringtrue
▹ openum(add, remove)trueBatch operation type type.
▹ refBatchOperation_reftrueTarget of batch operation.
▹▹ idstring(uuid)trueID of the resource.
▹▹ typeenum(scene)trueResource object type.
\n
","urlObject":{"path":["batches"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"23468ad8-2a90-4016-b39b-33a56a5ccf9a","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"vertexvis/batch:operations\": [\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"as-specified\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/batches"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"733162b3-0d8d-4b2c-a2bf-697f07be24d9","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"vertexvis/batch:operations\": [\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"as-specified\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/batches"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c8ba4869-4647-461b-9f4a-ed03bd29b97b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"vertexvis/batch:operations\": [\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"as-specified\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/batches"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f79cb58a-c375-4685-b673-828f2148b954","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"vertexvis/batch:operations\": [\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"as-specified\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/batches"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-batch"},{"name":"get Batch","id":"v-get-batch","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/batches/:id","description":"

Get a batch by ID.

\n","urlObject":{"path":["batches",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5f3428ac-023b-4f02-b0a1-ae6ae31eca09","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/batches/:id","host":["https://platform.vertexvis.com"],"path":["batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"vertexvis/batch:results\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n}"},{"id":"233ef92a-7e25-48cc-97a5-34542c5a0bda","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/batches/:id","host":["https://platform.vertexvis.com"],"path":["batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"827923c2-7f26-4249-90a1-fcbfb80c3466","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/batches/:id","host":["https://platform.vertexvis.com"],"path":["batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"34e71d72-a0f4-4f91-8386-ce13c3f202c4","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/batches/:id","host":["https://platform.vertexvis.com"],"path":["batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-batch"},{"name":"get Queued Batch","id":"v-get-queued-batch","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-batches/:id","description":"

Get a queued-batch. The response is either the status if running or error or, upon completion, redirects to the created batch.

\n","urlObject":{"path":["queued-batches",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-batch ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"87ec93a0-4663-4b9f-92fa-69751c349346","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-batches/:id","host":["https://platform.vertexvis.com"],"path":["queued-batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-batch` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b480dff4-81a3-4f2a-8a2c-9b8f4025451e","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-batches/:id","host":["https://platform.vertexvis.com"],"path":["queued-batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-batch` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b0c138b9-302c-4dbd-8572-9470d40513f2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-batches/:id","host":["https://platform.vertexvis.com"],"path":["queued-batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-batch` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e2866f50-32fa-416a-9d67-b82a19bb683c","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-batches/:id","host":["https://platform.vertexvis.com"],"path":["queued-batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-batch` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7d51b19e-62eb-466d-a479-fa663b80e71b","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-batches/:id","host":["https://platform.vertexvis.com"],"path":["queued-batches",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-batch` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-batch"}],"id":"v-batches","_postman_id":"v-batches","description":""},{"name":"canvases","item":[],"id":"v-canvases","_postman_id":"v-canvases","description":""},{"name":"collaboration-contexts","item":[{"name":"list Collaboration Contexts","id":"v-list-collaboration-contexts","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/collaboration-contexts?page[cursor]=&page[size]=","description":"

List collaboration-contexts

\n","urlObject":{"path":["collaboration-contexts"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"16391488-8bae-46db-b7a8-2bd529acd5a6","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"40b84ce5-8ccd-4bed-b303-d27b5eabb343","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a02d4673-9dd0-4d5e-a986-ba071dd63d9f","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"8493d89d-4237-4b5a-953e-e1413b9cb7ed","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-collaboration-contexts"},{"name":"create Collaboration Context","id":"v-create-collaboration-context","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"collaboration-context\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts","description":"

Create a collaboration-context.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateCollaborationContextRequest_datatrue
▹ typeenum(collaboration-context)trueResource object type.
\n
","urlObject":{"path":["collaboration-contexts"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"8ee921b4-d9e6-4e5f-b05a-0ced1016c061","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"collaboration-context\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b6073ddd-8e8f-4c21-85cb-74da2c826907","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"collaboration-context\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e38823d0-4b98-4881-b256-8d62f188eb49","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"collaboration-context\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4be7c2fe-5342-4245-9a63-24ee6fea585b","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"collaboration-context\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-collaboration-context"},{"name":"delete Collaboration Context","id":"v-delete-collaboration-context","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/collaboration-contexts/:id","description":"

Remove a collaboration context along with all of its data

\n","urlObject":{"path":["collaboration-contexts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The collaboration-context ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b68fe964-7a9e-425d-ab21-f3b594e72d4f","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7f85df93-4b43-40ea-a05a-1b5c31681fef","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"71d81a0c-70e3-4f4d-b3f7-83bf79cf43ee","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-collaboration-context"},{"name":"get Collaboration Context","id":"v-get-collaboration-context","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/collaboration-contexts/:id","description":"

Get a collaboration-context by ID.

\n","urlObject":{"path":["collaboration-contexts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The collaboration-context ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6d816bda-2abe-4c26-a93b-5b4f13029eb2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"account\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"57007776-a541-4ef3-bd4d-365bb67ea396","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e622380e-f055-41c7-981e-c252e6f608d5","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4d816886-ec5d-4b4e-ac78-7a881037e8e0","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-collaboration-context"},{"name":"add Collaboration Context User Groups","id":"add-collaboration-context-user-groups","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n },\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts/:id/user-groups","description":"

Create a collaboration-context.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
data[UserGroupId]true
▹ idstring(uuid)trueID of the resource.
▹ typeenum(user-group)trueResource object type.
\n
","urlObject":{"path":["collaboration-contexts",":id","user-groups"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The collaboration-context ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ab851c53-eaff-4a14-a137-0996ec8f767d","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n },\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/user-groups","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","user-groups"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"82fd7798-82de-4c77-ad1a-678b277af9ae","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n },\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/user-groups","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","user-groups"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"46599f04-d396-4aea-8b47-3e84138caceb","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n },\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/user-groups","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","user-groups"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c47c2d02-5591-49d6-a548-bc9d0d6a8343","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n },\n {\n \"id\": \"\",\n \"type\": \"user-group\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/user-groups","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","user-groups"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"add-collaboration-context-user-groups"},{"name":"get Users For Collaboration Context","id":"get-users-for-collaboration-context","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/collaboration-contexts/:id/users?filter[query]=&page[cursor]=&page[size]=","description":"

Search the users associated to a collaboration-context.

\n","urlObject":{"path":["collaboration-contexts",":id","users"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Query users by e-mail or full name

\n","type":"text/plain"},"key":"filter[query]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The collaboration-context ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"571927a5-e988-4a92-af0a-af4426b55b32","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/users?filter[query]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","users"],"query":[{"description":"Query users by e-mail or full name","key":"filter[query]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1d9ddca8-83e4-4b1f-ba25-3cdd7079ece3","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/users?filter[query]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","users"],"query":[{"description":"Query users by e-mail or full name","key":"filter[query]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c4e9371d-735d-494e-9cc8-a4c046561cde","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/users?filter[query]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","users"],"query":[{"description":"Query users by e-mail or full name","key":"filter[query]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"177a409a-3cb3-4f27-bd1f-6f477204a111","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/users?filter[query]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","users"],"query":[{"description":"Query users by e-mail or full name","key":"filter[query]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-users-for-collaboration-context"}],"id":"v-collaboration-contexts","description":"

Requires Engage Module

\n","_postman_id":"v-collaboration-contexts"},{"name":"documents","item":[{"name":"get Documents","id":"v-get-documents","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/documents?page[cursor]=&page[size]=&filter[suppliedId]=","description":"

Get documents.\nPreview: This is a preview API and is subject to change.

\n","urlObject":{"path":["documents"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""}],"variable":[]}},"response":[{"id":"743a542e-f4ec-4c86-ac1b-f1dbd2617459","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["documents"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"documentType\": \"PDF\",\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"document\"\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"documentType\": \"PDF\",\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"document\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8c352292-4de3-4182-bd81-7ca5248e1a59","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["documents"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a9ad4c09-da9a-48a6-a6b7-da75772d5b31","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["documents"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-documents"},{"name":"create Document","id":"v-create-document","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"document\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/documents","description":"

Creates a document.\nPreview: This is a preview API and is subject to change.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateDocumentRequest_datatrue
▹ attributesCreateDocumentRequest_data_attributestrue
▹▹ fileIdstring(uuid)true
▹▹ suppliedIdstringfalse
▹ typeenum(document)true
\n
","urlObject":{"path":["documents"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"05a64ecd-42a6-43ed-acd1-8f058073b92b","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"document\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/documents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"documentType\": \"PDF\",\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"document\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d5296680-70b7-4cd9-a547-45be63c4a157","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"document\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/documents"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b659605e-3b39-4792-a99a-c6818167d39d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"document\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/documents"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f1bf0d35-c88f-4189-bf82-aa0302149eaa","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"document\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/documents"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-document"},{"name":"get Document","id":"v-get-document","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/documents/:id","description":"

Get a document by ID.\nPreview: This is a preview API and is subject to change.

\n","urlObject":{"path":["documents",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The document ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b47ce7f5-ba1c-4e41-b506-353fb0d192b5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents/:id","host":["https://platform.vertexvis.com"],"path":["documents",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `document` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"documentType\": \"PDF\",\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"document\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e1b49f49-b7de-4d11-8d9b-b216cf600f40","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents/:id","host":["https://platform.vertexvis.com"],"path":["documents",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `document` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"812437c9-26f5-4ed0-b052-e50361222d90","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents/:id","host":["https://platform.vertexvis.com"],"path":["documents",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `document` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"bf358113-1749-40e8-b95c-0730ae466893","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents/:id","host":["https://platform.vertexvis.com"],"path":["documents",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `document` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-document"}],"id":"v-documents","_postman_id":"v-documents","description":""},{"name":"exports","item":[{"name":"create Export","id":"v-create-export","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"config\": {\n \"format\": \"\"\n },\n \"downloadUrlExpiry\": \"\",\n \"fileName\": \"\"\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"state\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/exports","description":"

Create an export. This API is asynchronous, returning the location of a queued-export. Check the status via the getQueuedExport API.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateExportRequest_datatrue
▹ attributesCreateExportRequest_data_attributestrue
▹▹ configanytrueSpecifies the export format and options to configure the export.
▹▹▹ anonymousExportConfigfalseDescribes the options for configuring a file export.
▹▹▹▹ formatstringtrue
▹▹ downloadUrlExpiryintegerfalseNumber of seconds before the download url for the export expires when retrieving a completed export. This expiry takes effect when retrieving the export and is valid for the specified time here.
▹▹ fileNamestringfalseOptional file name to use for the resulting export
▹ relationshipsCreateExportRequest_data_relationshipstrue
▹▹ sourceExportRelationshiptrueRelationship to an export.
▹▹▹ dataExportRelationshipDatatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene)trueResource object type.
▹▹ stateExportStateRelationshipfalseRelationship to an export.
▹▹▹ dataExportStateRelationshipDatatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene-view-state)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["exports"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"b8a9e65e-833a-4e8b-b509-6c0b70cbc751","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"config\": {\n \"format\": \"\"\n },\n \"downloadUrlExpiry\": \"\",\n \"fileName\": \"\"\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"state\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/exports"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"40f97da0-8ae7-468b-95e2-d5a4957eda92","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"config\": {\n \"format\": \"\"\n },\n \"downloadUrlExpiry\": \"\",\n \"fileName\": \"\"\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"state\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/exports"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"da4d09e2-02d2-47fc-96c2-b3dd4e20f99d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"config\": {\n \"format\": \"\"\n },\n \"downloadUrlExpiry\": \"\",\n \"fileName\": \"\"\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"state\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/exports"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a5d9d1f9-9b45-4c90-b1d2-e8245a41428e","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"config\": {\n \"format\": \"\"\n },\n \"downloadUrlExpiry\": \"\",\n \"fileName\": \"\"\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"state\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/exports"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-export"},{"name":"get Export","id":"v-get-export","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/exports/:id","description":"

Get an export by ID.

\n","urlObject":{"path":["exports",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The export ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e7b0ab81-ab05-446f-b261-5be126318a2c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/exports/:id","host":["https://platform.vertexvis.com"],"path":["exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `export` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"downloadUrl\": \"\",\n \"downloadUrlExpiry\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"file\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7cf1eb01-06dc-486e-b6f0-583afd957df0","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/exports/:id","host":["https://platform.vertexvis.com"],"path":["exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `export` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ae8505df-5e10-4b6e-84b6-d539381ce872","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/exports/:id","host":["https://platform.vertexvis.com"],"path":["exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `export` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3fba909c-d46a-4699-8dcd-bf8133842ce7","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/exports/:id","host":["https://platform.vertexvis.com"],"path":["exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `export` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-export"},{"name":"get Queued Export","id":"v-get-queued-export","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-exports/:id","description":"

Get a queued-export. The response is either the status if running or error or, upon completion, redirects to the created export.

\n","urlObject":{"path":["queued-exports",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-export ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8ea906c0-e3f4-46d1-8fa9-bd8ff5ef20b4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-exports/:id","host":["https://platform.vertexvis.com"],"path":["queued-exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-export` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"be96ebf9-f12e-4367-9d37-2498f7d8d08e","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-exports/:id","host":["https://platform.vertexvis.com"],"path":["queued-exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-export` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"23056508-28d0-46c9-b24d-76677f7040b9","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-exports/:id","host":["https://platform.vertexvis.com"],"path":["queued-exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-export` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"496ae8a7-4c6e-4991-bb73-d1c0c20656cb","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-exports/:id","host":["https://platform.vertexvis.com"],"path":["queued-exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-export` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4014e9a8-b55c-4578-af7b-736cd6e79128","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-exports/:id","host":["https://platform.vertexvis.com"],"path":["queued-exports",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-export` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-export"}],"id":"v-exports","_postman_id":"v-exports","description":""},{"name":"files","item":[{"name":"get Files","id":"v-get-files","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/files?page[cursor]=&page[size]=&sort=&filter[name]=false&filter[fileId]=7536&filter[suppliedId]=&filter[createdAt]=7536","description":"

Get files.

\n","urlObject":{"path":["files"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

A filter expression for the name to filter on.

\n","type":"text/plain"},"key":"filter[name]","value":"false"},{"description":{"content":"

A filter expression for the fileId to filter on.

\n","type":"text/plain"},"key":"filter[fileId]","value":"7536"},{"description":{"content":"

A filter for the suppliedId. The canonical form is a filter expression such as filter[suppliedId][contains]=.... The deprecated legacy filter[suppliedId]=id-1,id-2 exact-match CSV form is also accepted for backwards compatibility.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""},{"description":{"content":"

A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as filter[createdAt][gte]=2026-06-24T00:00:00Z.

\n","type":"text/plain"},"key":"filter[createdAt]","value":"7536"}],"variable":[]}},"response":[{"id":"3e6f1a52-c3cd-4c37-ae61-6d3c59560a81","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files?page[cursor]=&page[size]=&sort=&filter[name]=false&filter[fileId]=7536&filter[suppliedId]=&filter[createdAt]=7536","host":["https://platform.vertexvis.com"],"path":["files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"A filter expression for the `name` to filter on.","key":"filter[name]","value":"false"},{"description":"A filter expression for the `fileId` to filter on.","key":"filter[fileId]","value":"7536"},{"description":"A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[suppliedId]","value":""},{"description":"A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`.","key":"filter[createdAt]","value":"7536"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"dd45e166-c5f3-45ed-a8fa-7a01e1d7fe29","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files?page[cursor]=&page[size]=&sort=&filter[name]=false&filter[fileId]=7536&filter[suppliedId]=&filter[createdAt]=7536","host":["https://platform.vertexvis.com"],"path":["files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"A filter expression for the `name` to filter on.","key":"filter[name]","value":"false"},{"description":"A filter expression for the `fileId` to filter on.","key":"filter[fileId]","value":"7536"},{"description":"A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[suppliedId]","value":""},{"description":"A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`.","key":"filter[createdAt]","value":"7536"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"50e2db13-b151-4133-861f-1421b60cda7c","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files?page[cursor]=&page[size]=&sort=&filter[name]=false&filter[fileId]=7536&filter[suppliedId]=&filter[createdAt]=7536","host":["https://platform.vertexvis.com"],"path":["files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"A filter expression for the `name` to filter on.","key":"filter[name]","value":"false"},{"description":"A filter expression for the `fileId` to filter on.","key":"filter[fileId]","value":"7536"},{"description":"A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[suppliedId]","value":""},{"description":"A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`.","key":"filter[createdAt]","value":"7536"}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-files"},{"name":"create File","id":"v-create-file","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files","description":"

Create a file. Once created, upload file content via the uploadFile API. For details including supported file formats, see our Import data guide.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateFileRequest_datatrue
▹ attributesCreateFileRequest_data_attributestrue
▹▹ expiryinteger(int32)falseNumber of seconds before the file is deleted.
▹▹ metadataobjectfalseUser supplied key-value pairs for a file. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
▹▹▹ additionalPropertiesstringfalse
▹▹ namestringtrueName matching that of the file you are uploading, including file extension.
▹▹ rootFileNamestringfalseFile name of the root part or assembly, including file extension. Required if name references an archive file extension, ignored otherwise.
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["files"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"e278166c-a28e-4c13-a2c7-cd7226de4f5e","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5bd28426-dc23-4617-8067-1fea6765f732","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2144a72a-cc01-4703-bde7-b93cfe1eb8dd","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3be61a88-102d-45b7-a65a-0cdbdf18f375","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-file"},{"name":"delete File","id":"v-delete-file","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/files/:id","description":"

Delete a file.

\n","urlObject":{"path":["files",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2e820424-f630-4a70-95c3-6d6070fc722c","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3baddb13-f883-4b56-b0d1-e9b65c36a7bc","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a215da7d-3592-45d4-a0f2-f946356b9002","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a316ad17-bca0-47c2-8d86-b23eead6ab61","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-file"},{"name":"get File","id":"v-get-file","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/files/:id","description":"

Get a file by ID.

\n","urlObject":{"path":["files",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a8403ed3-9104-4e71-acd6-d91c91b28906","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0b853362-569c-48eb-a194-76d8d170d0a2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0d760b93-5135-443c-a6bb-21d88976d1f1","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b155a44b-31f3-4a43-a459-877ce04a3cc7","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-file"},{"name":"update File","id":"v-update-file","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files/:id","description":"

Update a file.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateFileRequest_datatrue
▹ attributesUpdateFileRequest_data_attributestrue
▹▹ expiryinteger(int32)¦nullfalseNumber of seconds before the file is deleted.
▹▹ metadataobjectfalseUpdates to file metadata. Null values delete the associated key/value pair.
▹▹▹ additionalPropertiesstring¦nullfalse
▹▹ namestringfalseName of the file you would like to rename
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["files",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"249bf215-81e1-4363-8e31-785c43cac38d","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c8fb3476-eb34-4d77-a902-c7446a301b63","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9dc36b59-8cae-4b43-8405-df0f569efb79","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"dac07d38-fffd-4010-81b5-b395f8b47b00","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"fa13a234-39a5-4bad-b435-959c83515c3f","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-file"},{"name":"upload File","id":"v-upload-file","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/octet-stream"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"file","file":{}},"url":"https://platform.vertexvis.com/files/:id","description":"

Upload a file. Once uploaded, create either parts or geometry sets via the createPart or createGeometrySet APIs.

\n","urlObject":{"path":["files",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0d99c840-defb-4539-916b-7601ffade6c8","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/octet-stream"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"file","file":{}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e363fdcf-7907-491d-9adc-0ab3bdb4a0fb","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/octet-stream"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"file","file":{}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d2558329-f16c-44c4-af16-a441047ce4ac","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/octet-stream"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"file","file":{}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"06e41efe-4443-4100-b35a-e3866098779d","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/octet-stream"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"file","file":{}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2b7c9619-2a87-4702-b913-ae9b84982c31","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/octet-stream"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"file","file":{}},"url":{"raw":"https://platform.vertexvis.com/files/:id","host":["https://platform.vertexvis.com"],"path":["files",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-upload-file"},{"name":"create Download Url","id":"v-create-download-url","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files/:id/download-url","description":"

Create a download uri for a file by ID.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateDownloadRequest_datatrue
▹ attributesCreateDownloadRequest_data_attributestrue
▹▹ expiryinteger(int32)falseSpecifies the duration for which this pre-signed request should be valid. After this time has expired, attempting to use the presigned request will fail. (Defaults to 1 hour, max value is 24 hours)
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["files",":id","download-url"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0366ae10-04cb-4101-b036-e6e38f9df1b4","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/download-url","host":["https://platform.vertexvis.com"],"path":["files",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"downloadUrl\": \"\",\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c45d0a38-d38f-42b6-ac2f-fe038fde3517","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/download-url","host":["https://platform.vertexvis.com"],"path":["files",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9142f92f-76b0-4995-aeae-be7d34e55f9b","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/download-url","host":["https://platform.vertexvis.com"],"path":["files",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"1d954e51-8b3d-4ac7-965b-b977640c432f","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/download-url","host":["https://platform.vertexvis.com"],"path":["files",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-download-url"},{"name":"list File Collections For File","id":"list-file-collections-for-file","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/files/:id/file-collections?page[cursor]=&page[size]=","description":"

List file-collection IDs associated with a file.

\n","urlObject":{"path":["files",":id","file-collections"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f087bdf0-6365-4923-86f9-7d95a57b702d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id/file-collections?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["files",":id","file-collections"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4b73bd3a-5517-409e-8493-620655484e82","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/files/:id/file-collections?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["files",":id","file-collections"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"list-file-collections-for-file"},{"name":"create Upload Url","id":"v-create-upload-url","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/files/:id/upload-url","description":"

Create an upload uri for a file by ID.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateUploadRequest_datatrue
▹ attributesCreateUploadRequest_data_attributestrue
▹▹ expiryinteger(int32)falseSpecifies the duration for which this pre-signed request should be valid for upload. After this time has expired, attempting to use the presigned request will fail. (Defaults to 1 hour, max value is 24 hours)
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["files",":id","upload-url"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"92c3daea-e45a-4664-a8f8-36091f5d48f2","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["files",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b74c4f18-de7b-4898-bc78-0fdf766a334d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["files",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"21120e28-2638-41bd-86b7-5d467b0babfe","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["files",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"92ce7b0d-ca99-400f-beec-e641b16beb68","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["files",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-upload-url"}],"id":"v-files","_postman_id":"v-files","description":""},{"name":"file-collections","item":[{"name":"list File Collections","id":"v-list-file-collections","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/file-collections?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&filter[createdAt]=7536&sort=-created","description":"

List file-collections with optional partial name, supplied ID, and creation time filters, sorted by name or creation time.

\n","urlObject":{"path":["file-collections"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

A filter expression for the file-collection name. The canonical form is a filter expression such as filter[name][contains]=....

\n","type":"text/plain"},"key":"filter[name]","value":"7536"},{"description":{"content":"

A filter expression for the file-collection supplied ID. The canonical form is a filter expression such as filter[suppliedId][contains]=....

\n","type":"text/plain"},"key":"filter[suppliedId]","value":"7536"},{"description":{"content":"

A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as filter[createdAt][gte]=2026-06-24T00:00:00Z.

\n","type":"text/plain"},"key":"filter[createdAt]","value":"7536"},{"description":{"content":"

A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. (This can only be one of name,-name,created,-created)

\n","type":"text/plain"},"key":"sort","value":"-created"}],"variable":[]}},"response":[{"id":"615d63a7-dba2-41cb-8f28-912eab7ea7d8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&filter[createdAt]=7536&sort=-created","host":["https://platform.vertexvis.com"],"path":["file-collections"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`.","key":"filter[name]","value":"7536"},{"description":"A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`.","key":"filter[suppliedId]","value":"7536"},{"description":"A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`.","key":"filter[createdAt]","value":"7536"},{"description":"A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. (This can only be one of name,-name,created,-created)","key":"sort","value":"-created"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d1139b04-811f-43f6-a230-eccfa487b310","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&filter[createdAt]=7536&sort=-created","host":["https://platform.vertexvis.com"],"path":["file-collections"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`.","key":"filter[name]","value":"7536"},{"description":"A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`.","key":"filter[suppliedId]","value":"7536"},{"description":"A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`.","key":"filter[createdAt]","value":"7536"},{"description":"A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. (This can only be one of name,-name,created,-created)","key":"sort","value":"-created"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"6f6a7ada-3a0e-48e7-a862-2d5020da0d1b","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&filter[createdAt]=7536&sort=-created","host":["https://platform.vertexvis.com"],"path":["file-collections"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter expression for the `file-collection` name. The canonical form is a filter expression such as `filter[name][contains]=...`.","key":"filter[name]","value":"7536"},{"description":"A filter expression for the `file-collection` supplied ID. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`.","key":"filter[suppliedId]","value":"7536"},{"description":"A filter expression for a resource's creation time. Use RFC 3339 timestamps, such as `filter[createdAt][gte]=2026-06-24T00:00:00Z`.","key":"filter[createdAt]","value":"7536"},{"description":"A sort to apply to file collections. A \"minus\" prefix before the field name specifies descending sort order. (This can only be one of name,-name,created,-created)","key":"sort","value":"-created"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-file-collections"},{"name":"create File Collection","id":"v-create-file-collection","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections","description":"

Create a file-collection.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateFileCollectionRequest_datatrue
▹ attributesCreateFileCollectionRequest_data_attributestrue
▹▹ expiryinteger(int32)falseNumber of seconds before expiration
▹▹ metadataobjectfalseUser supplied key-value pairs for a file-collection. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters.
▹▹▹ additionalPropertiesstringfalse
▹▹ namestringfalse
▹▹ suppliedIdstringfalseID provided for correlation with external systems, e.g. a PLM system.
▹ typeenum(file-collection)trueResource object type.
\n
","urlObject":{"path":["file-collections"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"7c49275f-d495-417b-acb9-2b181e38bac6","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"14a7ace0-9924-436d-8237-e0a24066a2fb","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d4c41d74-e841-48ea-b4a9-82619df69584","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-file-collection"},{"name":"delete File Collection","id":"v-delete-file-collection","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/file-collections/:id","description":"

Delete a file-collection.

\n","urlObject":{"path":["file-collections",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file-collection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"870eab69-df2b-47fc-bb0a-c664aacb622f","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"4b7968d2-1921-49b3-960b-7470200b000a","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"436409d4-f5b0-4d79-ac1c-af9f45166d9e","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-file-collection"},{"name":"get File Collection","id":"v-get-file-collection","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/file-collections/:id","description":"

Get a file-collection by ID.

\n","urlObject":{"path":["file-collections",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file-collection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f161dc1b-f2f7-45c4-8f5d-5bd711e745de","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fdde5e11-4a7f-4289-b015-ee1d4c6ee9e0","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7cd475ac-2d5b-49f9-92dd-382246fa1b0d","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-file-collection"},{"name":"update File Collection","id":"v-update-file-collection","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections/:id","description":"

Update a file-collection.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateFileCollectionRequest_datatrue
▹ attributesUpdateFileCollectionRequest_data_attributestrue
▹▹ expiryinteger(int32)falseNumber of seconds before expiration
▹▹ metadataobjectfalseUpdates to file collection metadata. Null values delete the associated key/value pair.
▹▹▹ additionalPropertiesstring¦nullfalse
▹ typeenum(file-collection)trueResource object type.
\n
","urlObject":{"path":["file-collections",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file-collection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b0def4cc-32f6-4106-82fa-fbaa0f0a4907","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3a25737e-96e1-46cc-86e2-6dfa5d04390b","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a4800e31-7b5f-4781-89a3-623806244cb4","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"faad0d70-d737-4ba6-be8b-35bb5d9050a2","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-file-collection"},{"name":"remove File Collection Files","id":"v-remove-file-collection-files","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/file-collections/:id/files?filter[fileId]=","description":"

Remove a file from a file-collection.

\n","urlObject":{"path":["file-collections",":id","files"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of file-ids to filter on.

\n","type":"text/plain"},"key":"filter[fileId]","value":""}],"variable":[{"description":{"content":"

(Required) The file-collection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c59eb038-4ede-4137-9d32-c4d11598850f","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?filter[fileId]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"Comma-separated list of file-ids to filter on.","key":"filter[fileId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"6e577896-7c55-43e1-a71e-77265d55b88a","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?filter[fileId]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"Comma-separated list of file-ids to filter on.","key":"filter[fileId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"842f7f17-67ac-4454-9c21-a568624102c3","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?filter[fileId]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"Comma-separated list of file-ids to filter on.","key":"filter[fileId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-remove-file-collection-files"},{"name":"list File Collection Files","id":"v-list-file-collection-files","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/file-collections/:id/files?page[cursor]=&page[size]=","description":"

List the files in a file-collection.

\n","urlObject":{"path":["file-collections",":id","files"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The file-collection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"90ee1c7c-2046-459c-80d6-f3cdf29af893","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b90e8123-d20a-4bb2-92c8-6a4834eba781","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"36402973-5ebe-4b65-9468-7321f03a7fc6","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-file-collection-files"},{"name":"add File Collection Files","id":"v-add-file-collection-files","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections/:id/files","description":"

Add files to a file-collection.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
data[Uuid]true[ID of the resource.]
\n
","urlObject":{"path":["file-collections",":id","files"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The file-collection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9c9e1047-e8b5-4029-8c2c-2b98404cb1f0","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8785fa3d-d8bb-4f67-82b7-6b25891b19a5","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"53d803d4-7aa5-49eb-aa11-40aa78998fd7","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3946b764-b2ee-4206-b935-86fa135cc149","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-add-file-collection-files"}],"id":"v-file-collections","_postman_id":"v-file-collections","description":""},{"name":"file-jobs","item":[{"name":"create File Job","id":"v-create-file-job","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"operation\": {\n \"fileId\": \"\",\n \"manifest\": [\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n },\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n }\n ],\n \"type\": \"file-archive-operation\"\n }\n },\n \"type\": \"file-job\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-jobs","description":"

Create a file-job.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateFileJobRequest_datatrue
▹ attributesCreateFileJobRequest_data_attributestrue
▹▹ operationFileJobArchiveOperationtrueAn object that describes the operation a file job will perform.
▹▹▹ fileIdstring(uuid)trueID of the resource.
▹▹▹ manifest[ArchiveManifestEntry]true[Represents a file and directory within an archive.]
▹▹▹▹ directorystringfalseThe directory in the archive where the file will be placed.
▹▹▹▹ selectoranytrueRepresents a query to select a file.
▹▹▹▹▹ anonymousSelectFileByIdfalseQueries a file by its unique ID.
▹▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(file-by-id)true
▹▹▹▹▹ anonymousSelectFileBySuppliedIdfalseQueries a file by its supplied ID.
▹▹▹▹▹▹ idstringtrue
▹▹▹▹▹▹ typeenum(file-by-supplied-id)true
▹▹▹ typeenum(file-archive-operation)true
▹ typeenum(file-job)trueResource object type.
\n
","urlObject":{"path":["file-jobs"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"8a114127-b44d-4764-87c3-dafcd2905486","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"operation\": {\n \"fileId\": \"\",\n \"manifest\": [\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n },\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n }\n ],\n \"type\": \"file-archive-operation\"\n }\n },\n \"type\": \"file-job\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-jobs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f9c04825-cb47-4adc-8cab-ac86e2970f57","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"operation\": {\n \"fileId\": \"\",\n \"manifest\": [\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n },\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n }\n ],\n \"type\": \"file-archive-operation\"\n }\n },\n \"type\": \"file-job\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-jobs"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2d5aa27b-d863-4402-8d68-b0ab7b80adf5","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"operation\": {\n \"fileId\": \"\",\n \"manifest\": [\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n },\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n }\n ],\n \"type\": \"file-archive-operation\"\n }\n },\n \"type\": \"file-job\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-jobs"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-file-job"},{"name":"get File Job","id":"v-get-file-job","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/file-jobs/:id","description":"

Get the status and result of a file-job.

\n","urlObject":{"path":["file-jobs",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The ID of a file job.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8d1e7f8f-608a-4fae-890d-b416cf2b1f9a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-jobs/:id","host":["https://platform.vertexvis.com"],"path":["file-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of a file job."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0d2563a7-5e96-4c46-89be-b4ce5b91ceab","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-jobs/:id","host":["https://platform.vertexvis.com"],"path":["file-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of a file job."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"63dc777b-c0e7-4136-bb4e-25c4e7672b0b","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-jobs/:id","host":["https://platform.vertexvis.com"],"path":["file-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of a file job."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3a506f61-c80a-4978-8bb7-8d79682695d0","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-jobs/:id","host":["https://platform.vertexvis.com"],"path":["file-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The ID of a file job."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-file-job"}],"id":"v-file-jobs","_postman_id":"v-file-jobs","description":""},{"name":"geometry-sets","item":[{"name":"get Geometry Sets","id":"v-get-geometry-sets","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/geometry-sets?page[cursor]=&page[size]=","description":"

Get geometry-sets.

\n","urlObject":{"path":["geometry-sets"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"6b8ab55e-afcc-4be5-b53c-d61554c26e73","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["geometry-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"393074f2-ec8b-4eab-bb21-47cc12860aae","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["geometry-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ec4b125e-ded8-4c3c-a20b-448129d8b343","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["geometry-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-geometry-sets"},{"name":"create Geometry Set","id":"v-create-geometry-set","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/geometry-sets","description":"

Create a geometry-set. Once created, create scenes via the createScene API. For details, see our Import data guide.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateGeometrySetRequest_datatrue
▹ relationshipsCreateGeometrySetRequest_data_relationshipstrue
▹▹ sourceFileRelationshiptrueRelationship to a file.
▹▹▹ dataFileRelationshipDatatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(file)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["geometry-sets"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"191fbeb3-6b12-4a87-8d3e-2194383b0b6d","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/geometry-sets"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5ff697f0-017c-41cf-81e3-83d30d7ac71e","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/geometry-sets"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2a79668c-16c5-4557-ac34-9b111611044b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/geometry-sets"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"385f2728-630d-44d8-9d36-5dadafb5b6cc","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/geometry-sets"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-geometry-set"},{"name":"get Geometry Set","id":"v-get-geometry-set","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/geometry-sets/:id","description":"

Get a geometry-set by ID.

\n","urlObject":{"path":["geometry-sets",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The geometry-set ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e1e94a50-50d5-4aee-a3d8-925263ff8445","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets/:id","host":["https://platform.vertexvis.com"],"path":["geometry-sets",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `geometry-set` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c5df4551-7bf2-4001-b1aa-fc48b4617714","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets/:id","host":["https://platform.vertexvis.com"],"path":["geometry-sets",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `geometry-set` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"46b5f508-28ae-4920-9ba3-8d2629551a97","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets/:id","host":["https://platform.vertexvis.com"],"path":["geometry-sets",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `geometry-set` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3843dfa6-7e16-4bde-819f-6383c674f450","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets/:id","host":["https://platform.vertexvis.com"],"path":["geometry-sets",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `geometry-set` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-geometry-set"}],"id":"v-geometry-sets","_postman_id":"v-geometry-sets","description":""},{"name":"hits","item":[{"name":"create Scene View Hit","id":"v-create-scene-view-hit","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-views/:id/hits?include=&fields[part-revision]=","description":"

Create a hit for a scene-view.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateHitRequest_datatrue
▹ attributesCreateHitRequest_data_attributestrue
▹▹ pointPointtrue2D point.
▹▹▹ dxinteger(int32)truex-axis coordinate.
▹▹▹ dyinteger(int32)truey-axis coordinate.
▹▹ viewportDimensionstrueAn item's height and width.
▹▹▹ heightinteger(int32)trueItem's height.
▹▹▹ widthinteger(int32)trueItem's width.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-views",":id","hits"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""},{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[part-revision]","value":""}],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f9ec3b90-aa7f-4b67-9eea-a6c23d606c34","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"results\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"type\": \"\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"point\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"type\": \"\"\n },\n {\n \"attributes\": {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"point\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"type\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4a6c83a8-8f14-4d9a-a984-832f2fce7cbf","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ba3cc62e-ce57-4621-b378-3fbcbc7619ac","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0793da67-5793-4149-a443-d55a0c100958","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4d12034e-39a6-4ff9-9a4b-91d2b235d07b","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-view-hit"},{"name":"create Scene Hit","id":"v-create-scene-hit","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/hits?include=&fields[part-revision]=","description":"

Create a hit for a scene.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateHitRequest_datatrue
▹ attributesCreateHitRequest_data_attributestrue
▹▹ pointPointtrue2D point.
▹▹▹ dxinteger(int32)truex-axis coordinate.
▹▹▹ dyinteger(int32)truey-axis coordinate.
▹▹ viewportDimensionstrueAn item's height and width.
▹▹▹ heightinteger(int32)trueItem's height.
▹▹▹ widthinteger(int32)trueItem's width.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id","hits"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""},{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[part-revision]","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4acca124-0dbd-44ea-b301-711ebfce3a0c","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"results\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ]\n },\n \"type\": \"\"\n },\n \"included\": [\n {\n \"attributes\": {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"point\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"type\": \"\"\n },\n {\n \"attributes\": {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"point\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"id\": \"\",\n \"type\": \"\"\n }\n },\n \"type\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"05929fc6-898e-486b-8dde-2e39f75d0b4a","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"24dfa67c-23a0-44d1-ba4f-ceeed7227d6b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"eb5c0b55-5b56-4c46-b84f-77647161fbfc","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7d1b8226-fcb2-4c0f-bba3-58ec5aea261b","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"point\": {\n \"dx\": \"\",\n \"dy\": \"\"\n },\n \"viewport\": {\n \"height\": \"\",\n \"width\": \"\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/hits?include=&fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","hits"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-hit"}],"id":"v-hits","_postman_id":"v-hits","description":""},{"name":"model-views","item":[{"name":"get Model View","id":"v-get-model-view","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/model-views/:id","description":"

Get the details of a model-view.

\n","urlObject":{"path":["model-views",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The model-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"39fead9d-9e14-402c-8565-f4d409ea8fb9","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/model-views/:id","host":["https://platform.vertexvis.com"],"path":["model-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `model-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"58cdadeb-d324-4258-a275-c11f7ec7b276","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/model-views/:id","host":["https://platform.vertexvis.com"],"path":["model-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `model-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"1cf7b869-add2-44c1-bcf5-3124d5003eb4","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/model-views/:id","host":["https://platform.vertexvis.com"],"path":["model-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `model-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7a2650ab-a160-44b6-a133-e06b8c6d2551","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/model-views/:id","host":["https://platform.vertexvis.com"],"path":["model-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `model-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-model-view"},{"name":"get Part Revision Model Views","id":"get-part-revision-model-views","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/part-revisions/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","description":"

Get a paged list of model-views for a part revision.

\n","urlObject":{"path":["part-revisions",":id","model-views"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Filter model views that contain or do not contain annotations.

\n","type":"text/plain"},"key":"filter[hasAnnotations]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The part-revision ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dbc4ff7a-7adc-4b52-8310-f3665aa030fc","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"6a51af0e-8a95-498f-83ab-3366e7fcab14","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"741eb502-4db7-4204-ac3b-fe6034271ec9","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"30839aca-fbe3-4f76-b250-407d3fe35441","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-part-revision-model-views"},{"name":"get Scene Item Model Views","id":"get-scene-item-model-views","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-items/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","description":"

Get a paged list of model-views for a scene item.

\n","urlObject":{"path":["scene-items",":id","model-views"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Filter model views that contain or do not contain annotations.

\n","type":"text/plain"},"key":"filter[hasAnnotations]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The scene-item ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d28165e0-d86a-4060-8d64-77f7dbe2a986","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5e81930b-0866-4c0e-bbfe-d6aad28446b2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"82680a1a-f30a-4383-9889-f7b42293ef3c","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9e3db9e8-3eae-4350-9e42-657ba243856a","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id/model-views?filter[hasAnnotations]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id","model-views"],"query":[{"description":"Filter model views that contain or do not contain annotations.","key":"filter[hasAnnotations]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-scene-item-model-views"}],"id":"v-model-views","_postman_id":"v-model-views","description":""},{"name":"oauth2","item":[{"name":"admin Accept Consent","id":"v-admin-accept-consent","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"session\": {}\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/oauth2/auth/requests/consent/accept?challenge=","description":"

Accept Consent Challenge to login.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataAdminConsentAcceptRequest_datatrue
▹ attributesAdminConsentAcceptRequest_data_attributestrue
▹▹ sessionobjecttrue
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["oauth2","auth","requests","consent","accept"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

(Required) Challenge ID from oauth2 flow

\n","type":"text/plain"},"key":"challenge","value":""}],"variable":[]}},"response":[{"id":"608cb92d-a245-489b-97c2-a943548d242c","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"session\": {}\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/oauth2/auth/requests/consent/accept?challenge=","host":["https://platform.vertexvis.com"],"path":["oauth2","auth","requests","consent","accept"],"query":[{"description":"(Required) Challenge ID from oauth2 flow","key":"challenge","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"redirectTo\": \"\"\n}"},{"id":"e6fc00e3-d1b9-4c68-8df3-26c57c71fec9","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"session\": {}\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/oauth2/auth/requests/consent/accept?challenge=","host":["https://platform.vertexvis.com"],"path":["oauth2","auth","requests","consent","accept"],"query":[{"description":"(Required) Challenge ID from oauth2 flow","key":"challenge","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"031ba4d9-b76b-4c7d-af47-5e3c800e23f6","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"session\": {}\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/oauth2/auth/requests/consent/accept?challenge=","host":["https://platform.vertexvis.com"],"path":["oauth2","auth","requests","consent","accept"],"query":[{"description":"(Required) Challenge ID from oauth2 flow","key":"challenge","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-admin-accept-consent"},{"name":"admin Accept Login","id":"v-admin-accept-login","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"scope","value":""},{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"subject\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/oauth2/auth/requests/login/accept?login_challenge=","description":"

Accept Login Challenge with subject & login challenge

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataAdminLoginAcceptRequest_datatrue
▹ attributesAdminLoginAcceptRequest_data_attributestrue
▹▹ subjectstringtrue
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["oauth2","auth","requests","login","accept"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

(Required) Login Challenge ID from oauth2 flow

\n","type":"text/plain"},"key":"login_challenge","value":""}],"variable":[]}},"response":[{"id":"8af25cae-7cb2-4ba3-a5c3-e35684ebe10f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"subject\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/oauth2/auth/requests/login/accept?login_challenge=","host":["https://platform.vertexvis.com"],"path":["oauth2","auth","requests","login","accept"],"query":[{"description":"(Required) Login Challenge ID from oauth2 flow","key":"login_challenge","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"redirectTo\": \"\"\n}"},{"id":"b5007c56-fd14-4114-add1-749584bf8887","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"subject\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/oauth2/auth/requests/login/accept?login_challenge=","host":["https://platform.vertexvis.com"],"path":["oauth2","auth","requests","login","accept"],"query":[{"description":"(Required) Login Challenge ID from oauth2 flow","key":"login_challenge","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"6b304ed4-1600-4969-9573-f201b941f571","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"subject\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/oauth2/auth/requests/login/accept?login_challenge=","host":["https://platform.vertexvis.com"],"path":["oauth2","auth","requests","login","accept"],"query":[{"description":"(Required) Login Challenge ID from oauth2 flow","key":"login_challenge","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-admin-accept-login"},{"name":"revoke Token","id":"v-revoke-token","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{basicAuthUsername}}"},{"key":"password","value":"{{basicAuthPassword}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"token\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/oauth2/revoke","description":"

Revoke an OAuth2 access token.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataRevokeOAuth2TokenRequest_datatrue
▹ attributesRevokeOAuth2TokenRequest_data_attributestrue
▹▹ tokenstringtrueToken to revoke.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["oauth2","revoke"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"be008183-736f-4d45-a910-f9ca4f98e4b7","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"token\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/oauth2/revoke"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"v-revoke-token"},{"name":"create Token","id":"v-create-token","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{basicAuthUsername}}"},{"key":"password","value":"{{basicAuthPassword}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"

(Required)

\n","key":"grant_type","value":""},{"key":"code","value":""},{"key":"redirect_uri","value":""},{"key":"refresh_token","value":""},{"key":"scope","value":""},{"key":"subject_token","value":""},{"key":"subject_token_type","value":""}]},"url":"https://platform.vertexvis.com/oauth2/token","description":"

Create an OAuth2 access token. For details, see our Authentication guide.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
codeNonEmptyStringfalse
grant_typestringtrue
redirect_uriNonEmptyStringfalse
refresh_tokenNonEmptyStringfalse
scopestringfalse
subject_tokenstringfalse
subject_token_typeNonEmptyStringfalse
\n
","urlObject":{"path":["oauth2","token"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"09bc5628-714b-48aa-aff0-8fb86e5437f0","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) ","key":"grant_type","value":""},{"key":"code","value":""},{"key":"redirect_uri","value":""},{"key":"refresh_token","value":""},{"key":"scope","value":""},{"key":"subject_token","value":""},{"key":"subject_token_type","value":""}]},"url":"https://platform.vertexvis.com/oauth2/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"\",\n \"account_id\": \"\",\n \"expires_in\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"token_type\": \"\",\n \"refresh_token\": \"\"\n}"},{"id":"263227ed-2da8-4014-b9d1-e75242132485","name":"Invalid or missing request.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required) ","key":"grant_type","value":""},{"key":"code","value":""},{"key":"redirect_uri","value":""},{"key":"refresh_token","value":""},{"key":"scope","value":""},{"key":"subject_token","value":""},{"key":"subject_token_type","value":""}]},"url":"https://platform.vertexvis.com/oauth2/token"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"\"\n}"}],"_postman_id":"v-create-token"}],"id":"v-oauth2","_postman_id":"v-oauth2","description":""},{"name":"part-renditions","item":[{"name":"get Part Renditions","id":"v-get-part-renditions","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/part-renditions?page[cursor]=&page[size]=&filter[suppliedId]=&filter[revisionId]=","description":"

Get part-renditions with an optional filter.

\n","urlObject":{"path":["part-renditions"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""},{"description":{"content":"

A revision ID to filter on.

\n","type":"text/plain"},"key":"filter[revisionId]","value":""}],"variable":[]}},"response":[{"id":"7d9c91c3-969d-4ac3-b52d-86189280be00","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions?page[cursor]=&page[size]=&filter[suppliedId]=&filter[revisionId]=","host":["https://platform.vertexvis.com"],"path":["part-renditions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"A revision ID to filter on.","key":"filter[revisionId]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"82f457c2-2431-4a8d-95b1-6abf55de95b8","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions?page[cursor]=&page[size]=&filter[suppliedId]=&filter[revisionId]=","host":["https://platform.vertexvis.com"],"path":["part-renditions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"A revision ID to filter on.","key":"filter[revisionId]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"517d882a-144a-426e-80a6-ea78082e1244","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions?page[cursor]=&page[size]=&filter[suppliedId]=&filter[revisionId]=","host":["https://platform.vertexvis.com"],"path":["part-renditions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"A revision ID to filter on.","key":"filter[revisionId]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-part-renditions"},{"name":"get Part Rendition","id":"v-get-part-rendition","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/part-renditions/:id","description":"

Get a part-rendition by ID.

\n","urlObject":{"path":["part-renditions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The part-rendition ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"62656db0-9e10-47e1-bb09-7b33fe1583f7","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions/:id","host":["https://platform.vertexvis.com"],"path":["part-renditions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-rendition` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"baafb5cc-a0a6-4d19-94d2-424bc6134008","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions/:id","host":["https://platform.vertexvis.com"],"path":["part-renditions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-rendition` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5e1a6b75-e607-48c0-b33d-231bfc590d7f","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions/:id","host":["https://platform.vertexvis.com"],"path":["part-renditions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-rendition` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a2c8e3ac-a81d-445e-8078-ceaadd4f8235","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-renditions/:id","host":["https://platform.vertexvis.com"],"path":["part-renditions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-rendition` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-part-rendition"},{"name":"create Part Rendition","id":"v-create-part-rendition","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","description":"

Creates a part-rendition associated with a part-revision

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreatePartRenditionRequest_datatrueCreate a new part rendition.
▹ attributesCreatePartRenditionRequest_data_attributestrue
▹▹ makeDefaultbooleanfalseWhether or not to replace the default rendition for the part revision with the newly created rendition.
▹▹ namestringfalse
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹ relationshipsCreateGeometrySetRequest_data_relationshipsfalse
▹▹ sourceFileRelationshiptrueRelationship to a file.
▹▹▹ dataFileRelationshipDatatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(file)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["part-revisions",":id","part-renditions"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The part-revision ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"424015c4-1473-45ae-94f4-9d2f5f7132fd","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","part-renditions"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1a8bd304-d129-43f3-aa32-30edec6b1483","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","part-renditions"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8ff2132d-28b5-4c5d-9ca7-eae28d37c1e0","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","part-renditions"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"274be034-d282-4b7a-ba39-85eae8c6028e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","part-renditions"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9a33676a-c5a6-43d4-a13c-36f794aba4bd","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","part-renditions"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0b2f57db-aca6-4384-9e01-f06b8e237f36","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"makeDefault\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/part-renditions","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","part-renditions"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-part-rendition"}],"id":"v-part-renditions","_postman_id":"v-part-renditions","description":""},{"name":"part-revisions","item":[{"name":"delete Part Revision","id":"v-delete-part-revision","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/part-revisions/:id","description":"

Delete a part-revision.

\n","urlObject":{"path":["part-revisions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The part-revision ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e2f9ba88-fbad-4d19-bc67-557e0f5c001d","name":"Accepted","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"09c9fea6-23f2-4fe1-9269-2847270aa841","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"82b89ec5-6ed0-4bd4-a9da-e09913d1bb64","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7f182256-f1b1-4e66-a683-cd3a9ab7cd2f","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-part-revision"},{"name":"get Part Revision","id":"v-get-part-revision","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/part-revisions/:id?fields[part-revision]=","description":"

Get a part-revision by ID.

\n","urlObject":{"path":["part-revisions",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[part-revision]","value":""}],"variable":[{"description":{"content":"

(Required) The part-revision ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4922abb2-cbdd-4976-95df-38622f02dc8e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id?fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"151a5f81-5a7c-4127-91b3-960ee31d0604","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id?fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"cf5b532c-e12b-4a96-9155-0186b48bf0c2","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id?fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"96082666-61d0-4cdb-b936-5a7b91ac7378","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id?fields[part-revision]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[part-revision]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-part-revision"},{"name":"update Part Revision","id":"v-update-part-revision","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/part-revisions/:id","description":"

Update a part-revision. When given a file relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, indexMetadata, name, suppliedIdKey, suppliedRevisionIdKey, and suppliedInstanceIdKey. Note that geometry updates are eventually consistent and will not update existing scenes.\nFor updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdatePartRevisionRequest_datatrueModify existing part revisions using this endpoint. When specifying a relationship, the generated output from that relationship will be used to replace any relationship that is present on the revision prior to the update.
▹ attributesUpdatePartRevisionRequest_data_attributestrue
▹▹ indexMetadatabooleanfalseWhether or not to index metadata in the part file when sending a file relationship - not used otherwise. To ignore metadata from the part file and add your own, pass false for indexMetadata and supply custom metadata using the metadata field.
▹▹ metadataobjectfalseMetadata about the part and/or part-revision. This metadata will take precedence over any metadata that belongs to the part file if indexMetadata is specified.
▹▹▹ additionalPropertiesanyfalse
▹▹▹▹ anonymousMetadataLongTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valueinteger(int64)trueA numerical long value.
▹▹▹▹ anonymousMetadataFloatTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuenumber(float)trueA numerical floating-point value.
▹▹▹▹ anonymousMetadataDateTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestring(date-time)trueA date value.
▹▹▹▹ anonymousMetadataStringTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestringtrueA string value.
▹▹▹▹ anonymousMetadataNullTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹ namestringfalseName to be used for the root part. This will be used when given a file relationship - not used otherwise.
▹▹ suppliedIdKeystringfalseMetadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
▹▹ suppliedInstanceIdKeystringfalseMetadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
▹▹ suppliedRevisionIdKeystringfalseMetadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
▹ idstring(uuid)trueID of the resource.
▹ relationshipsUpdatePartRevisionRequest_data_relationshipsfalse
▹▹ childrenPartRevisionChildrenfalse
▹▹▹ dataFileRelationshipDatatrueID of a uploaded file that contains assembly children in JSON format.
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(file)trueResource object type.
▹▹ defaultPartRenditionPartRenditionRelationshipfalseRelationship to a part-rendition.
▹▹▹ dataPartRenditionRelationship_datatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(part-rendition)trueResource object type.
▹▹ sourceFileRelationshipfalseRelationship to a file.
▹▹▹ dataFileRelationshipDatatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(file)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["part-revisions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The part-revision ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c7e223e7-dd89-477c-aab1-3114fa715cf3","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4e8aebe9-cfed-48eb-8510-6e0574c15c8a","name":"Accepted","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fa904629-e8f6-4107-8c39-57d275db2d7d","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"eb1e56fb-d155-48db-9f0f-83ad5f70c421","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"256187a8-c34d-4f68-9143-160399847ff7","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d2e4dd26-04f1-477f-931e-a8c1aaeb4dbc","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"relationships\": {\n \"children\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n },\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-part-revision"},{"name":"render Part Revision","id":"v-render-part-revision","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"image/jpeg"}],"url":"https://platform.vertexvis.com/part-revisions/:id/image?height=&width=&camera[position][x]=&camera[position][y]=&camera[position][z]=&camera[up][x]=&camera[up][y]=&camera[up][z]=&camera[lookAt][x]=&camera[lookAt][y]=&camera[lookAt][z]=&camera[perspective][position][x]=&camera[perspective][position][y]=&camera[perspective][position][z]=&camera[perspective][lookAt][x]=&camera[perspective][lookAt][y]=&camera[perspective][lookAt][z]=&camera[perspective][up][x]=&camera[perspective][up][y]=&camera[perspective][up][z]=&camera[orthographic][viewVector][x]=&camera[orthographic][viewVector][y]=&camera[orthographic][viewVector][z]=&camera[orthographic][lookAt][x]=&camera[orthographic][lookAt][y]=&camera[orthographic][lookAt][z]=&camera[orthographic][up][x]=&camera[orthographic][up][y]=&camera[orthographic][up][z]=&camera[orthographic][fovHeight]=","description":"

Get a rendered image of a part-revision.

\n","urlObject":{"path":["part-revisions",":id","image"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The height of the image to render.

\n","type":"text/plain"},"key":"height","value":""},{"description":{"content":"

The width of the image to render.

\n","type":"text/plain"},"key":"width","value":""},{"description":{"content":"

The camera position vector.

\n","type":"text/plain"},"key":"camera[position][x]","value":""},{"description":{"content":"

The camera position vector.

\n","type":"text/plain"},"key":"camera[position][y]","value":""},{"description":{"content":"

The camera position vector.

\n","type":"text/plain"},"key":"camera[position][z]","value":""},{"description":{"content":"

The camera up vector.

\n","type":"text/plain"},"key":"camera[up][x]","value":""},{"description":{"content":"

The camera up vector.

\n","type":"text/plain"},"key":"camera[up][y]","value":""},{"description":{"content":"

The camera up vector.

\n","type":"text/plain"},"key":"camera[up][z]","value":""},{"description":{"content":"

The camera lookAt vector.

\n","type":"text/plain"},"key":"camera[lookAt][x]","value":""},{"description":{"content":"

The camera lookAt vector.

\n","type":"text/plain"},"key":"camera[lookAt][y]","value":""},{"description":{"content":"

The camera lookAt vector.

\n","type":"text/plain"},"key":"camera[lookAt][z]","value":""},{"description":{"content":"

The perspective camera position.

\n","type":"text/plain"},"key":"camera[perspective][position][x]","value":""},{"description":{"content":"

The perspective camera position.

\n","type":"text/plain"},"key":"camera[perspective][position][y]","value":""},{"description":{"content":"

The perspective camera position.

\n","type":"text/plain"},"key":"camera[perspective][position][z]","value":""},{"description":{"content":"

The perspective camera look at position.

\n","type":"text/plain"},"key":"camera[perspective][lookAt][x]","value":""},{"description":{"content":"

The perspective camera look at position.

\n","type":"text/plain"},"key":"camera[perspective][lookAt][y]","value":""},{"description":{"content":"

The perspective camera look at position.

\n","type":"text/plain"},"key":"camera[perspective][lookAt][z]","value":""},{"description":{"content":"

The perspective camera up vector.

\n","type":"text/plain"},"key":"camera[perspective][up][x]","value":""},{"description":{"content":"

The perspective camera up vector.

\n","type":"text/plain"},"key":"camera[perspective][up][y]","value":""},{"description":{"content":"

The perspective camera up vector.

\n","type":"text/plain"},"key":"camera[perspective][up][z]","value":""},{"description":{"content":"

The orthographic camera view vector.

\n","type":"text/plain"},"key":"camera[orthographic][viewVector][x]","value":""},{"description":{"content":"

The orthographic camera view vector.

\n","type":"text/plain"},"key":"camera[orthographic][viewVector][y]","value":""},{"description":{"content":"

The orthographic camera view vector.

\n","type":"text/plain"},"key":"camera[orthographic][viewVector][z]","value":""},{"description":{"content":"

The orthographic camera look at position.

\n","type":"text/plain"},"key":"camera[orthographic][lookAt][x]","value":""},{"description":{"content":"

The orthographic camera look at position.

\n","type":"text/plain"},"key":"camera[orthographic][lookAt][y]","value":""},{"description":{"content":"

The orthographic camera look at position.

\n","type":"text/plain"},"key":"camera[orthographic][lookAt][z]","value":""},{"description":{"content":"

The orthographic camera up vector.

\n","type":"text/plain"},"key":"camera[orthographic][up][x]","value":""},{"description":{"content":"

The orthographic camera up vector.

\n","type":"text/plain"},"key":"camera[orthographic][up][y]","value":""},{"description":{"content":"

The orthographic camera up vector.

\n","type":"text/plain"},"key":"camera[orthographic][up][z]","value":""},{"description":{"content":"

The orthographic field-of-view height.

\n","type":"text/plain"},"key":"camera[orthographic][fovHeight]","value":""}],"variable":[{"description":{"content":"

(Required) The part-revision ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"09f847a9-58be-433f-bb38-3690ee7ac457","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"image/jpeg"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/image?height=&width=&camera[position][x]=&camera[position][y]=&camera[position][z]=&camera[up][x]=&camera[up][y]=&camera[up][z]=&camera[lookAt][x]=&camera[lookAt][y]=&camera[lookAt][z]=&camera[perspective][position][x]=&camera[perspective][position][y]=&camera[perspective][position][z]=&camera[perspective][lookAt][x]=&camera[perspective][lookAt][y]=&camera[perspective][lookAt][z]=&camera[perspective][up][x]=&camera[perspective][up][y]=&camera[perspective][up][z]=&camera[orthographic][viewVector][x]=&camera[orthographic][viewVector][y]=&camera[orthographic][viewVector][z]=&camera[orthographic][lookAt][x]=&camera[orthographic][lookAt][y]=&camera[orthographic][lookAt][z]=&camera[orthographic][up][x]=&camera[orthographic][up][y]=&camera[orthographic][up][z]=&camera[orthographic][fovHeight]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""},{"description":"The `camera` position vector.","key":"camera[position][x]","value":""},{"description":"The `camera` position vector.","key":"camera[position][y]","value":""},{"description":"The `camera` position vector.","key":"camera[position][z]","value":""},{"description":"The `camera` up vector.","key":"camera[up][x]","value":""},{"description":"The `camera` up vector.","key":"camera[up][y]","value":""},{"description":"The `camera` up vector.","key":"camera[up][z]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][x]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][y]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][z]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][x]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][y]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][z]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][x]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][y]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][z]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][x]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][y]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][z]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][x]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][y]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][z]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][x]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][y]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][z]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][x]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][y]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][z]","value":""},{"description":"The orthographic field-of-view height.","key":"camera[orthographic][fovHeight]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"image/jpeg"}],"cookie":[],"responseTime":null,"body":""},{"id":"9ed4413e-ad46-4aa4-bd7a-458da2cbe960","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/image?height=&width=&camera[position][x]=&camera[position][y]=&camera[position][z]=&camera[up][x]=&camera[up][y]=&camera[up][z]=&camera[lookAt][x]=&camera[lookAt][y]=&camera[lookAt][z]=&camera[perspective][position][x]=&camera[perspective][position][y]=&camera[perspective][position][z]=&camera[perspective][lookAt][x]=&camera[perspective][lookAt][y]=&camera[perspective][lookAt][z]=&camera[perspective][up][x]=&camera[perspective][up][y]=&camera[perspective][up][z]=&camera[orthographic][viewVector][x]=&camera[orthographic][viewVector][y]=&camera[orthographic][viewVector][z]=&camera[orthographic][lookAt][x]=&camera[orthographic][lookAt][y]=&camera[orthographic][lookAt][z]=&camera[orthographic][up][x]=&camera[orthographic][up][y]=&camera[orthographic][up][z]=&camera[orthographic][fovHeight]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""},{"description":"The `camera` position vector.","key":"camera[position][x]","value":""},{"description":"The `camera` position vector.","key":"camera[position][y]","value":""},{"description":"The `camera` position vector.","key":"camera[position][z]","value":""},{"description":"The `camera` up vector.","key":"camera[up][x]","value":""},{"description":"The `camera` up vector.","key":"camera[up][y]","value":""},{"description":"The `camera` up vector.","key":"camera[up][z]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][x]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][y]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][z]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][x]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][y]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][z]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][x]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][y]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][z]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][x]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][y]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][z]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][x]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][y]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][z]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][x]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][y]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][z]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][x]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][y]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][z]","value":""},{"description":"The orthographic field-of-view height.","key":"camera[orthographic][fovHeight]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"51785ab7-632b-4a82-af4a-d09a149ffd63","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/image?height=&width=&camera[position][x]=&camera[position][y]=&camera[position][z]=&camera[up][x]=&camera[up][y]=&camera[up][z]=&camera[lookAt][x]=&camera[lookAt][y]=&camera[lookAt][z]=&camera[perspective][position][x]=&camera[perspective][position][y]=&camera[perspective][position][z]=&camera[perspective][lookAt][x]=&camera[perspective][lookAt][y]=&camera[perspective][lookAt][z]=&camera[perspective][up][x]=&camera[perspective][up][y]=&camera[perspective][up][z]=&camera[orthographic][viewVector][x]=&camera[orthographic][viewVector][y]=&camera[orthographic][viewVector][z]=&camera[orthographic][lookAt][x]=&camera[orthographic][lookAt][y]=&camera[orthographic][lookAt][z]=&camera[orthographic][up][x]=&camera[orthographic][up][y]=&camera[orthographic][up][z]=&camera[orthographic][fovHeight]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""},{"description":"The `camera` position vector.","key":"camera[position][x]","value":""},{"description":"The `camera` position vector.","key":"camera[position][y]","value":""},{"description":"The `camera` position vector.","key":"camera[position][z]","value":""},{"description":"The `camera` up vector.","key":"camera[up][x]","value":""},{"description":"The `camera` up vector.","key":"camera[up][y]","value":""},{"description":"The `camera` up vector.","key":"camera[up][z]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][x]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][y]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][z]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][x]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][y]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][z]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][x]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][y]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][z]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][x]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][y]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][z]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][x]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][y]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][z]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][x]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][y]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][z]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][x]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][y]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][z]","value":""},{"description":"The orthographic field-of-view height.","key":"camera[orthographic][fovHeight]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"885f1b30-edf9-4ae8-a2fb-f491ced1c27d","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/image?height=&width=&camera[position][x]=&camera[position][y]=&camera[position][z]=&camera[up][x]=&camera[up][y]=&camera[up][z]=&camera[lookAt][x]=&camera[lookAt][y]=&camera[lookAt][z]=&camera[perspective][position][x]=&camera[perspective][position][y]=&camera[perspective][position][z]=&camera[perspective][lookAt][x]=&camera[perspective][lookAt][y]=&camera[perspective][lookAt][z]=&camera[perspective][up][x]=&camera[perspective][up][y]=&camera[perspective][up][z]=&camera[orthographic][viewVector][x]=&camera[orthographic][viewVector][y]=&camera[orthographic][viewVector][z]=&camera[orthographic][lookAt][x]=&camera[orthographic][lookAt][y]=&camera[orthographic][lookAt][z]=&camera[orthographic][up][x]=&camera[orthographic][up][y]=&camera[orthographic][up][z]=&camera[orthographic][fovHeight]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""},{"description":"The `camera` position vector.","key":"camera[position][x]","value":""},{"description":"The `camera` position vector.","key":"camera[position][y]","value":""},{"description":"The `camera` position vector.","key":"camera[position][z]","value":""},{"description":"The `camera` up vector.","key":"camera[up][x]","value":""},{"description":"The `camera` up vector.","key":"camera[up][y]","value":""},{"description":"The `camera` up vector.","key":"camera[up][z]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][x]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][y]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][z]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][x]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][y]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][z]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][x]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][y]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][z]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][x]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][y]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][z]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][x]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][y]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][z]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][x]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][y]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][z]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][x]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][y]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][z]","value":""},{"description":"The orthographic field-of-view height.","key":"camera[orthographic][fovHeight]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2e58c7f0-2f89-438f-841b-4847044d41cb","name":"GatewayTimeout","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revisions/:id/image?height=&width=&camera[position][x]=&camera[position][y]=&camera[position][z]=&camera[up][x]=&camera[up][y]=&camera[up][z]=&camera[lookAt][x]=&camera[lookAt][y]=&camera[lookAt][z]=&camera[perspective][position][x]=&camera[perspective][position][y]=&camera[perspective][position][z]=&camera[perspective][lookAt][x]=&camera[perspective][lookAt][y]=&camera[perspective][lookAt][z]=&camera[perspective][up][x]=&camera[perspective][up][y]=&camera[perspective][up][z]=&camera[orthographic][viewVector][x]=&camera[orthographic][viewVector][y]=&camera[orthographic][viewVector][z]=&camera[orthographic][lookAt][x]=&camera[orthographic][lookAt][y]=&camera[orthographic][lookAt][z]=&camera[orthographic][up][x]=&camera[orthographic][up][y]=&camera[orthographic][up][z]=&camera[orthographic][fovHeight]=","host":["https://platform.vertexvis.com"],"path":["part-revisions",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""},{"description":"The `camera` position vector.","key":"camera[position][x]","value":""},{"description":"The `camera` position vector.","key":"camera[position][y]","value":""},{"description":"The `camera` position vector.","key":"camera[position][z]","value":""},{"description":"The `camera` up vector.","key":"camera[up][x]","value":""},{"description":"The `camera` up vector.","key":"camera[up][y]","value":""},{"description":"The `camera` up vector.","key":"camera[up][z]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][x]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][y]","value":""},{"description":"The `camera` lookAt vector.","key":"camera[lookAt][z]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][x]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][y]","value":""},{"description":"The perspective camera position.","key":"camera[perspective][position][z]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][x]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][y]","value":""},{"description":"The perspective camera look at position.","key":"camera[perspective][lookAt][z]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][x]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][y]","value":""},{"description":"The perspective camera up vector.","key":"camera[perspective][up][z]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][x]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][y]","value":""},{"description":"The orthographic camera view vector.","key":"camera[orthographic][viewVector][z]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][x]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][y]","value":""},{"description":"The orthographic camera look at position.","key":"camera[orthographic][lookAt][z]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][x]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][y]","value":""},{"description":"The orthographic camera up vector.","key":"camera[orthographic][up][z]","value":""},{"description":"The orthographic field-of-view height.","key":"camera[orthographic][fovHeight]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part-revision` ID."}]}},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-render-part-revision"},{"name":"get Part Revisions","id":"v-get-part-revisions","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/parts/:id/part-revisions?page[cursor]=&page[size]=&filter[suppliedId]=","description":"

Get part-revisions for a part.

\n","urlObject":{"path":["parts",":id","part-revisions"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""}],"variable":[{"description":{"content":"

(Required) The part ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2b99bb33-6101-4474-adbe-aaf04a91185c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id/part-revisions?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["parts",":id","part-revisions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4149e9ce-600c-4a04-bdb3-a372604c9516","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id/part-revisions?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["parts",":id","part-revisions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"30f35a6d-c1cf-4445-a00d-e379d519db20","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id/part-revisions?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["parts",":id","part-revisions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0870a53f-a582-4a1f-9842-a17767dd943e","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id/part-revisions?page[cursor]=&page[size]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["parts",":id","part-revisions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-part-revisions"},{"name":"get Queued Part Revision Deletion","id":"get-queued-part-revision-deletion","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-part-revision-deletions/:id","description":"

Get a queued-part-revision-deletion by ID.

\n","urlObject":{"path":["queued-part-revision-deletions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-part-revision-deletion ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"36941957-48a8-4730-bd7a-d4edb3d7bfb4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-revision-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-revision-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-revision-deletion` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fe543271-7f06-43ed-8035-14853a571eb8","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-revision-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-revision-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-revision-deletion` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"933d7923-ba46-4dc9-8b2a-50c81863f3ac","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-revision-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-revision-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-revision-deletion` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ee327198-ea08-4077-a9ef-840bae3f1596","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-revision-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-revision-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-revision-deletion` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-queued-part-revision-deletion"}],"id":"v-part-revisions","_postman_id":"v-part-revisions","description":""},{"name":"part-revision-instances","item":[{"name":"get Part Revision Instance List","id":"get-part-revision-instance-list","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/part-revision-instances?filter[parent]=&page[cursor]=&page[size]=","description":"

Gets a page of 'part-revision' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.

\n","urlObject":{"path":["part-revision-instances"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Parent ID to filter on. Sending null will return items without a parent.

\n","type":"text/plain"},"key":"filter[parent]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"7aff4d5c-3984-4be3-a705-b5746d37469a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revision-instances?filter[parent]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revision-instances"],"query":[{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"ordinal\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\"\n },\n {\n \"attributes\": {\n \"ordinal\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"43969df2-4bab-41b7-8688-875e8d8d35c2","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revision-instances?filter[parent]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revision-instances"],"query":[{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"bb339e5c-da8c-455c-878c-bc57abd513b2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revision-instances?filter[parent]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revision-instances"],"query":[{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a25365f4-3dc6-4032-a122-75b3537c8996","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revision-instances?filter[parent]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revision-instances"],"query":[{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"bd21f271-3119-4e5c-b2f6-f8878d07efd8","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/part-revision-instances?filter[parent]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["part-revision-instances"],"query":[{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-part-revision-instance-list"}],"id":"v-part-revision-instances","_postman_id":"v-part-revision-instances","description":""},{"name":"parts","item":[{"name":"get Parts","id":"v-get-parts","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","description":"

Get parts.

\n","urlObject":{"path":["parts"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""},{"description":{"content":"

Owner ID to filter on.

\n","type":"text/plain"},"key":"filter[ownerId]","value":""}],"variable":[]}},"response":[{"id":"0d04d698-cfb8-4438-bf1c-bac7997dee6c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","host":["https://platform.vertexvis.com"],"path":["parts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Owner ID to filter on.","key":"filter[ownerId]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"partRevisions\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n ],\n \"owner\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"partRevisions\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n ],\n \"owner\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"a5fb07aa-e64a-4bd6-a5e9-80fb816b5d65","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","host":["https://platform.vertexvis.com"],"path":["parts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Owner ID to filter on.","key":"filter[ownerId]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b4d0e99c-70c2-4643-8d83-26c0e5a2afc4","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","host":["https://platform.vertexvis.com"],"path":["parts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Owner ID to filter on.","key":"filter[ownerId]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-parts"},{"name":"create Part","id":"v-create-part","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"revisionName\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedIterationId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"instances\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n }\n ]\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts","description":"

Create a part.

\n

This endpoint includes multiple successful response codes: [201, 202].

\n

When not given a relationship, this endpoint will create a part with an empty part revision and return a 201\nstatus code of the part.

\n

When given a relationship to translate, this endpoint will return a 202 status code with the location of a\nqueued-translation. The status of the translation can be queried via getQueuedTranslation. After the\ntranslation is complete, a part and part-revision that references the translated geometry.

\n

A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending\nmy-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for my-part-id,\nlikewise you can invoke this endpoint with a new revision id: my-part-id/my-new-revision-id and a new revision will be created for the\nexisting part.

\n

See our Import Data guides for more\ninformation.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreatePartRequest_datatrue
▹ attributesCreatePartRequest_data_attributestrue
▹▹ indexMetadatabooleanfalseWhether or not to index metadata in the part file. To ignore metadata from the part file and add your own, pass false for indexMetadata and supply custom metadata using the metadata field.
▹▹ metadataobjectfalseAdditional metadata about the part and/or part-revision. This metadata will take precedence over any metadata that belongs to the part file if indexMetadata is specified.
▹▹▹ additionalPropertiesanyfalse
▹▹▹▹ anonymousMetadataLongTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valueinteger(int64)trueA numerical long value.
▹▹▹▹ anonymousMetadataFloatTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuenumber(float)trueA numerical floating-point value.
▹▹▹▹ anonymousMetadataDateTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestring(date-time)trueA date value.
▹▹▹▹ anonymousMetadataStringTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestringtrueA string value.
▹▹▹▹ anonymousMetadataNullTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹ namestringfalseName to be used for the root part.
▹▹ revisionNamestringfalseOptional name to be used for the part revision.
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ suppliedIdKeystringfalseMetadata key used to extract an ID used for correlation.
▹▹ suppliedInstanceIdKeystringfalseMetadata key used to extract an ID used for correlation.
▹▹ suppliedIterationIdstringfalseID provided for correlation of the revision. This is an optional ID to be able to create
▹▹ suppliedRevisionIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ suppliedRevisionIdKeystringfalseMetadata key used to extract an ID used for correlation.
▹ relationshipsCreatePartRequest_data_relationshipsfalse
▹▹ instancesPartInstancesRelationshipfalsePart Revision Assembly Instance Data
▹▹▹ data[PartInstancesRelationship_data]trueEach child must include the UUID of the revision. The optional transform may be included to position the child relative to the parent. See the Matrix4 schema for details. Note: The children will be ordered as they appear in the array. Also, it is suggested to not include the transform for any that has identity transform to keep the payload size small. Example file content: {
▹▹▹▹ attributesPartInstancesRelationship_attributesfalse
▹▹▹▹▹ transformMatrix4false4x4 affine transformation matrix.
▹▹▹▹▹▹ r0Vector4true4D vector.
▹▹▹▹▹▹▹ wnumbertruew value.
▹▹▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹▹▹ r1Vector4true4D vector.
▹▹▹▹▹▹ r2Vector4true4D vector.
▹▹▹▹▹▹ r3Vector4true4D vector.
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(part-revision-instance)trueResource object type.
▹▹ sourceanyfalse
▹▹▹ anonymousFileRelationshipfalseRelationship to a file.
▹▹▹▹ dataFileRelationshipDatatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(file)trueResource object type.
▹▹▹ anonymousDeprecatedPartAssemblyRelationshipfalseCreate Part Assembly
▹▹▹▹ dataDeprecatedPartAssemblyRelationship_datatrue
▹▹▹▹▹ children[PartRevisionInstance]true[A reference to an existing PartRevision. Specify one and only one of referenceId or suppliedReferenceId to refer to a revision.]
▹▹▹▹▹▹ ordinalintegertrueA 0-based index used for defining a consistent ordering for children of an assembly
▹▹▹▹▹▹ revisionIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹ suppliedRevisionIdNonEmptyStringfalseThis has been deprecated. Use instead the revisionId to reference the revision instance. The revisionId can be found by using the List Part Revisions endpoint.
▹▹▹▹▹▹ transformMatrix4false4x4 affine transformation matrix.
▹▹▹▹▹ metadataobjectfalseAdditional metadata about the part and/or part-revision.
▹▹▹▹▹▹ additionalPropertiesanyfalse
▹▹▹▹▹▹▹ anonymousMetadataLongTypefalse
▹▹▹▹▹▹▹ anonymousMetadataFloatTypefalse
▹▹▹▹▹▹▹ anonymousMetadataDateTypefalse
▹▹▹▹▹▹▹ anonymousMetadataStringTypefalse
▹▹▹▹▹▹▹ anonymousMetadataNullTypefalse
▹ typestringtrueResource object type. Specify one and only one of suppliedId or suppliedIdKey and one and only one of suppliedRevisionId or suppliedRevisionIdKey.
\n
","urlObject":{"path":["parts"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"2f1a5b1e-2843-48ce-a3a6-6cc7ea4034fa","name":"Created Part","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"revisionName\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedIterationId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"instances\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n }\n ]\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"partRevisions\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n ],\n \"owner\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d35b5882-b613-419a-af67-e3cbc1ca95cd","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"revisionName\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedIterationId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"instances\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n }\n ]\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"30638aa3-8f5e-4a53-8415-db07d4965f0b","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"revisionName\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedIterationId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"instances\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n }\n ]\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f1b6e298-29cd-4610-a567-d475209120a1","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"revisionName\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedIterationId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"instances\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n }\n ]\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5d48da9d-291e-4a75-b042-26239192ac39","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"indexMetadata\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"revisionName\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIdKey\": \"\",\n \"suppliedInstanceIdKey\": \"\",\n \"suppliedIterationId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedRevisionIdKey\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"instances\": {\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision-instance\",\n \"attributes\": {\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n }\n }\n ]\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-part"},{"name":"delete Part","id":"v-delete-part","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/parts/:id","description":"

Delete a part.

\n","urlObject":{"path":["parts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The part ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"479c6605-31b7-434c-b614-554c31e5c93e","name":"Accepted","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9a79db28-3496-4249-93e4-4623f524355e","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d14c285e-53c2-4937-874f-a38bdd4c6883","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"686cfbd4-db72-4791-8d4a-54591778fa40","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-part"},{"name":"get Part","id":"v-get-part","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/parts/:id?include=","description":"

Get a part by ID.

\n","urlObject":{"path":["parts",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""}],"variable":[{"description":{"content":"

(Required) The part ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a24ce9bb-0011-414b-a1d1-3f8b9d260214","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id?include=","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"partRevisions\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n ],\n \"owner\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"270d4b9b-0e65-415f-833b-ea5ef2460317","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id?include=","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"567d8f69-0079-4c80-bfbe-5011a13249a5","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id?include=","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0b6b54b9-ba01-4a64-92b4-e9df38331c46","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts/:id?include=","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-part"},{"name":"update Part","id":"v-update-part","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/parts/:id","description":"

Update a part by ID

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdatePartRequest_datatrue
▹ attributesUpdatePartRequest_data_attributestrue
▹▹ namestringfalseName to be used for the root part.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["parts",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The part ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2b76bcb2-bdb2-4576-a092-3fab75fadc51","name":"No Content","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"db2a420b-cac2-421b-925a-b6dc2e038bab","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3d6a971f-5a51-4303-8c18-65d675aa3537","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"76790d27-d5de-41df-9b66-39b2f979b459","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/parts/:id","host":["https://platform.vertexvis.com"],"path":["parts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `part` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-part"},{"name":"get Queued Part Deletion","id":"v-get-queued-part-deletion","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-part-deletions/:id","description":"

Get a queued-part-deletion by ID.

\n","urlObject":{"path":["queued-part-deletions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-part-deletion ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8fffea46-0d72-453c-bf24-61d380183ca0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-deletion` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c00f59d9-8157-4ebe-9172-ef6bfbf92e29","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-deletion` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"68fab570-9cda-4dce-81a5-3e345e5a7e06","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-deletion` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3c2a4506-23ef-4a7c-aba4-54eaef078198","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-part-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-part-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-part-deletion` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-part-deletion"}],"id":"v-parts","_postman_id":"v-parts","description":""},{"name":"permission-grants","item":[{"name":"List all permission grants","id":"v-list-all-permission-grants","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/permission-grants?page[cursor]=&page[size]=","description":"

List all permission grants

\n","urlObject":{"path":["permission-grants"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"202152e1-4aad-42cc-bec0-31414d4ea445","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/permission-grants?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["permission-grants"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"id\": \"\",\n \"type\": \"permission-grant\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"id\": \"\",\n \"type\": \"permission-grant\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"176fd9d5-c969-443f-a7aa-b84df31e6934","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/permission-grants?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["permission-grants"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-all-permission-grants"},{"name":"Create a permission grant for a grantee to a subject resource","id":"v-post-permission-grants","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"type\": \"permission-grant\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/permission-grants","description":"

Create a permission grant for a grantee to a subject resource

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreatePermissionGrant_datatrue
▹ attributesCreatePermissionGrant_data_attributestrue
▹▹ capabilityenum(read)true
▹▹ granteePermissionGranteetrueThe grantee portion of a permission grant tuple
▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹ typeenum(account)true
▹▹ subjectPermissionSubjecttrueA resource category subject to a permission grant
▹▹▹ anonymousPartsDomainSubjectfalseA subject domain encompassing all part resources
▹▹▹▹ domainenum(parts)true
▹▹▹ anonymousPropertySetDomainSubjectfalseA subject domain encompassing all property set resources
▹▹▹▹ domainenum(property-sets)true
▹ typeenum(permission-grant)true
\n
","urlObject":{"path":["permission-grants"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"452f9f6e-0a8c-4b27-ba7b-45f57a30593f","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"type\": \"permission-grant\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/permission-grants"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"id\": \"\",\n \"type\": \"permission-grant\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c560b8fe-4a1f-45e1-8c5a-be76bf2757a7","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"type\": \"permission-grant\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/permission-grants"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"32c686b4-8fcd-49fa-b538-0e58f81a3519","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"type\": \"permission-grant\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/permission-grants"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"58945d77-99bb-4cb5-8a96-1993397bd022","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"type\": \"permission-grant\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/permission-grants"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-post-permission-grants"},{"name":"Remove a permission grant by ID","id":"remove-a-permission-grant-by-id","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/permission-grants/:id","description":"

Remove a permission grant by ID

\n","urlObject":{"path":["permission-grants",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The permission grant ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"remove-a-permission-grant-by-id"},{"name":"Get a permission grant by ID","id":"get-a-permission-grant-by-id","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/permission-grants/:id","description":"

Get a permission grant by ID

\n","urlObject":{"path":["permission-grants",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The permission grant ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"get-a-permission-grant-by-id"}],"id":"v-permission-grants","_postman_id":"v-permission-grants","description":""},{"name":"pmi","item":[{"name":"get Pmi Annotations","id":"v-get-pmi-annotations","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/pmi-annotations?filter[modelViewId]=&page[cursor]=&page[size]=","description":"

List pmi-annotations.

\n","urlObject":{"path":["pmi-annotations"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Filter annotations belonging to a model view.

\n","type":"text/plain"},"key":"filter[modelViewId]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"235ccf87-02ee-46d3-ad5c-2a585b99ab21","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/pmi-annotations?filter[modelViewId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["pmi-annotations"],"query":[{"description":"Filter annotations belonging to a model view.","key":"filter[modelViewId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"520168a1-b4f8-4da8-9496-a79e2a05de90","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/pmi-annotations?filter[modelViewId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["pmi-annotations"],"query":[{"description":"Filter annotations belonging to a model view.","key":"filter[modelViewId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"12f18241-9ac0-48c5-8439-a8b72c5dd4b5","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/pmi-annotations?filter[modelViewId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["pmi-annotations"],"query":[{"description":"Filter annotations belonging to a model view.","key":"filter[modelViewId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"25c85c1d-d632-4d81-9915-b59fd6d1308f","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/pmi-annotations?filter[modelViewId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["pmi-annotations"],"query":[{"description":"Filter annotations belonging to a model view.","key":"filter[modelViewId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-pmi-annotations"}],"id":"v-pmi","description":"

Requires Engage Module

\n","_postman_id":"v-pmi"},{"name":"property-entries","item":[{"name":"get Property Entries","id":"v-get-property-entries","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/property-entries?page[cursor]=&page[size]=&filter[resourceId]=&filter[resourceType]=","description":"

Get property-entries by a resource ID

\n","urlObject":{"path":["property-entries"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

A resource ID to filter on

\n","type":"text/plain"},"key":"filter[resourceId]","value":""},{"description":{"content":"

The provided type for the resource ids

\n","type":"text/plain"},"key":"filter[resourceType]","value":""}],"variable":[]}},"response":[{"id":"4cc1e60c-ca92-41cd-822f-a2bfe1a62b67","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-entries?page[cursor]=&page[size]=&filter[resourceId]=&filter[resourceType]=","host":["https://platform.vertexvis.com"],"path":["property-entries"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A resource ID to filter on","key":"filter[resourceId]","value":""},{"description":"The provided type for the resource ids","key":"filter[resourceType]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"key\": {\n \"name\": \"\"\n },\n \"value\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"key\": {\n \"name\": \"\"\n },\n \"value\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e6a3dbd0-795d-4d3b-ba79-beea9d34991f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-entries?page[cursor]=&page[size]=&filter[resourceId]=&filter[resourceType]=","host":["https://platform.vertexvis.com"],"path":["property-entries"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A resource ID to filter on","key":"filter[resourceId]","value":""},{"description":"The provided type for the resource ids","key":"filter[resourceType]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ccc6a501-ff0e-4bec-bfc8-a0090fcccbac","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-entries?page[cursor]=&page[size]=&filter[resourceId]=&filter[resourceType]=","host":["https://platform.vertexvis.com"],"path":["property-entries"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A resource ID to filter on","key":"filter[resourceId]","value":""},{"description":"The provided type for the resource ids","key":"filter[resourceType]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-property-entries"},{"name":"upsert Property Entries","id":"v-upsert-property-entries","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"entries\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n }\n },\n \"relationships\": {\n \"propertySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-entries","description":"

Upsert property-entries for a provided resource.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpsertPropertyEntriesRequest_datatrue
▹ attributesUpsertPropertyEntriesRequest_data_attributestrue
▹▹ entriesobjecttrueProperty entries for a provided resource or property set.
▹▹▹ additionalPropertiesanyfalse
▹▹▹▹ anonymousPropertyStringTypefalse
▹▹▹▹▹ typeenum(string)trueType of property-entry value.
▹▹▹▹▹ valuestringtrueA string value.
▹▹▹▹ anonymousPropertyDoubleTypefalse
▹▹▹▹▹ typeenum(double)trueType of property value.
▹▹▹▹▹ valuenumber(double)true
▹▹▹▹ anonymousPropertyLongTypefalse
▹▹▹▹▹ typeenum(long)trueType of property-entry value.
▹▹▹▹▹ valueinteger(int64)trueA numerical long value.
▹▹▹▹ anonymousPropertyDateTypefalse
▹▹▹▹▹ typeenum(date)trueType of property value.
▹▹▹▹▹ valuestring(date-time)trueA date value.
▹▹▹▹ anonymousobject¦nullfalse
▹ relationshipsUpsertPropertyEntriesRequest_data_relationshipstrue
▹▹ propertySetanytrueRelationship to the property set by property-set, part-revision, part-instance or scene-item.
▹▹▹ anonymousPropertySetRelationshipfalseRelationship to a property-set.
▹▹▹▹ dataPropertySetRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(property-set)trueResource object type.
▹▹▹ anonymousPartRevisionRelationshipfalseRelationship to a part-revision.
▹▹▹▹ dataPartData_relationships_partRevisionstrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(part-revision)trueResource object type.
▹▹▹ anonymousSceneItemRelationshipfalseRelationship to a scene-item.
▹▹▹▹ dataSceneItemRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(scene-item)trueResource object type.
▹▹▹ anonymousPartInstanceRelationshipfalseRelationship to a part-instance.
▹▹▹▹ dataPartInstanceRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(part-instance)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["property-entries"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"92a617e1-aa61-4296-94c1-a52ff7888fe3","name":"No Content","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"entries\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n }\n },\n \"relationships\": {\n \"propertySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-entries"},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"7f01c9cc-494f-4189-8583-dc22a68dd531","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"entries\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n }\n },\n \"relationships\": {\n \"propertySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-entries"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"348b874a-7070-48d6-a0cd-ffe478a13134","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"entries\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n }\n },\n \"relationships\": {\n \"propertySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-entries"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"eeb11afc-6bfd-4f77-8b85-09726d0d222d","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"entries\": {\n \"key_0\": {\n \"type\": \"string\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n }\n },\n \"relationships\": {\n \"propertySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-entries"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-upsert-property-entries"}],"id":"v-property-entries","_postman_id":"v-property-entries","description":""},{"name":"property-key-policies","item":[{"name":"list Property Key Policies","id":"v-list-property-key-policies","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/property-key-policies?page[cursor]=&page[size]=&filter[suppliedId]=7536","description":"

List property-key-policies.

\n","urlObject":{"path":["property-key-policies"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

The supplied ID filter expression for property key policies.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":"7536"}],"variable":[]}},"response":[{"id":"c0afe9f8-e3d8-42f3-a5d3-cda63f26976c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies?page[cursor]=&page[size]=&filter[suppliedId]=7536","host":["https://platform.vertexvis.com"],"path":["property-key-policies"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"filter[suppliedId]","value":"7536"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"mode\": \"denylist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key-policy\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key-policy\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"70687452-00be-47b0-884c-9bf0e2766349","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies?page[cursor]=&page[size]=&filter[suppliedId]=7536","host":["https://platform.vertexvis.com"],"path":["property-key-policies"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"filter[suppliedId]","value":"7536"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e3eb7c5a-c782-4513-a994-a0368577914a","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies?page[cursor]=&page[size]=&filter[suppliedId]=7536","host":["https://platform.vertexvis.com"],"path":["property-key-policies"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"filter[suppliedId]","value":"7536"}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-property-key-policies"},{"name":"create Property Key Policy","id":"v-create-property-key-policy","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"property-key-policy\",\n \"attributes\": {\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies","description":"

Create a property-key-policy.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreatePropertyKeyPolicyRequestDatatrue
▹ attributesCreatePropertyKeyPolicyRequestDataAttributesfalse
▹▹ modePropertyKeyPolicyModefalse
▹▹ namestringfalse
▹▹ suppliedIdstringfalseID provided for correlation with external systems, e.g. a PLM system.
▹ typeenum(property-key-policy)true
\n
","urlObject":{"path":["property-key-policies"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"0082e21e-afad-4c9a-98db-b05123fbfb9f","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"property-key-policy\",\n \"attributes\": {\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"mode\": \"denylist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key-policy\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n },\n \"key_4\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"eb99a889-07d8-451d-9fb2-440f6f553f06","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"property-key-policy\",\n \"attributes\": {\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"65c376a4-4882-422d-8e7a-b584acc61fbb","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"property-key-policy\",\n \"attributes\": {\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e39029b7-e516-4a48-be72-06fed8dd601f","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"property-key-policy\",\n \"attributes\": {\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3b7b2419-f98d-4ff3-8a0e-e9b283527e5f","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"property-key-policy\",\n \"attributes\": {\n \"mode\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-property-key-policy"},{"name":"delete Property Key Policy","id":"v-delete-property-key-policy","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/property-key-policies/:id","description":"

Delete a property-key-policy.

\n","urlObject":{"path":["property-key-policies",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The property-key-policy ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"10e259dd-d348-4e14-b72d-396d2f5dff86","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"bb0b9fcc-e990-4dee-bbb2-24a9e46e2d73","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c291ce33-ea08-4ae0-a7d2-9a90aa02487f","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"fa6d930d-37b0-44c5-859c-42bef1a28a97","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-property-key-policy"},{"name":"get Property Key Policy","id":"v-get-property-key-policy","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/property-key-policies/:id","description":"

Get a property-key-policy.

\n","urlObject":{"path":["property-key-policies",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The property-key-policy ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6c4a9cf2-59e4-4da5-a33b-08d02bf17fc5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"mode\": \"denylist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key-policy\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n },\n \"key_4\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9ed91896-9bfe-497c-bd1b-25c31e423869","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"841a3c6c-00d7-42e5-a8fc-bba2f00afe9a","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3e1fcf65-8961-4524-a8a6-0e5f9c25d13f","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-property-key-policy"},{"name":"delete Property Key Policy Keys","id":"delete-property-key-policy-keys","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/property-key-policies/:id/keys?filter[id]=","description":"

Delete property keys from a property-key-policy.

\n","urlObject":{"path":["property-key-policies",":id","keys"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of IDs to filter on.

\n","type":"text/plain"},"key":"filter[id]","value":""}],"variable":[{"description":{"content":"

(Required) The property-key-policy ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4d4e057e-7f7c-48a9-8d3f-a9cde4448a6f","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e691851a-444a-46fe-9535-537a77838682","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"23b72df7-ed56-4c48-aca1-1d68239dab44","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"844065a3-d92b-4a6f-a1c1-73f2b4a71385","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"delete-property-key-policy-keys"},{"name":"list Property Key Policy Keys","id":"list-property-key-policy-keys","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/property-key-policies/:id/keys?page[cursor]=&page[size]=","description":"

Get property keys for a property-key-policy.

\n","urlObject":{"path":["property-key-policies",":id","keys"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The property-key-policy ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"37fa6b17-10f7-4070-8415-ded25c184689","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1e9e4831-503c-46f2-9482-fa892d3b0e7e","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a48f5015-b4d1-4c28-b229-1079143f1e28","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d1bba50a-fb57-4ab0-a930-ceb96026f021","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"56f13925-5e93-4a0d-b5c7-b2de5f327d90","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"list-property-key-policy-keys"},{"name":"upsert Property Key Policy Keys","id":"upsert-property-key-policy-keys","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/property-key-policies/:id/keys","description":"

Upsert property keys for a property-key-policy.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
data[PropertyEntryKey]true
▹ namestringtrue
\n
","urlObject":{"path":["property-key-policies",":id","keys"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The property-key-policy ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ab2bc8e2-2ee6-4463-bfcb-3a7e85a2de02","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b232b237-fad1-4d4f-b20f-effaa6649786","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"017ad5ae-4072-4704-a7bf-f67fcadeef21","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"75481dea-fcde-426f-814a-8a4525aecf60","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f257cfcb-096d-457c-a9cd-b8c278910003","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"name\": \"\"\n },\n {\n \"name\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/property-key-policies/:id/keys","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","keys"],"variable":[{"key":"id","value":"","description":"(Required) The `property-key-policy` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"upsert-property-key-policy-keys"}],"id":"v-property-key-policies","_postman_id":"v-property-key-policies","description":""},{"name":"replies","item":[{"name":"list Replies","id":"v-list-replies","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/replies?filter[threadId]=&page[cursor]=&page[size]=&include=","description":"

List replies

\n","urlObject":{"path":["replies"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[threadId]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""}],"variable":[]}},"response":[{"id":"5c0e50dc-aab3-419f-8b21-c88e5b6e5fe9","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies?filter[threadId]=&page[cursor]=&page[size]=&include=","host":["https://platform.vertexvis.com"],"path":["replies"],"query":[{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[threadId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ]\n}"},{"id":"ddfa7ff7-9e34-447b-a446-50a9ce2938c3","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies?filter[threadId]=&page[cursor]=&page[size]=&include=","host":["https://platform.vertexvis.com"],"path":["replies"],"query":[{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[threadId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"56ef2095-f6ec-40a7-9cfa-b9700d9bd88a","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies?filter[threadId]=&page[cursor]=&page[size]=&include=","host":["https://platform.vertexvis.com"],"path":["replies"],"query":[{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[threadId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"14ecd516-9a50-4d7e-a583-68de2d9140f6","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies?filter[threadId]=&page[cursor]=&page[size]=&include=","host":["https://platform.vertexvis.com"],"path":["replies"],"query":[{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[threadId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-replies"},{"name":"delete Reply","id":"v-delete-reply","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/replies/:id","description":"

Remove a reply.

\n","urlObject":{"path":["replies",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"075e6f7e-2f3d-4011-8bcd-36e288b56fa7","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"25f6542b-9653-4e3d-81fd-5d5e65100ff5","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"8f3ed3cb-8972-47fe-b3b9-778db4e1ace4","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-reply"},{"name":"get Reply","id":"v-get-reply","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/replies/:id?include=","description":"

Get a reply.

\n","urlObject":{"path":["replies",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""}],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e7414642-8c35-4cd3-867e-95700ffc0fea","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id?include=","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5a22e677-b532-4b14-bb47-da85ffc0c5e4","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id?include=","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b2d30109-8c8b-45aa-bad8-ba5701027e3f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id?include=","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d5e11853-3a86-4f04-8874-d74109bd0042","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id?include=","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-reply"},{"name":"update Reply","id":"v-update-reply","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/replies/:id","description":"

Update a reply.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateReplyRequest_datatrue
▹ attributesUpdateReplyRequest_data_attributestrue
▹▹ isDraftingbooleanfalse
▹▹ withBodyDocumentWithBodyDocumentfalse
▹▹▹ documentTextDocumenttrue
▹▹▹▹ rootRootNodetrue
▹▹▹▹▹ content[oneOf]trueList of nodes
▹▹▹▹▹▹ content[oneOf]trueList of paragraph nodes
▹▹▹▹▹▹▹ anonymousTextNodefalse
▹▹▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹▹▹ typeenum(text-node)true
▹▹▹▹▹▹▹ anonymousMentionNodefalse
▹▹▹▹▹▹▹▹ typeenum(mention-node)true
▹▹▹▹▹▹▹▹ userIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(paragraph-node)true
▹▹▹▹▹ typeenum(root-node)true
▹▹▹▹ typeenum(text-document-v1)true
▹▹▹ typeenum(with-body-document)true
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["replies",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"fb592b94-2c77-4baa-b6bd-f5668dfa4aa5","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"bb8de699-fe5a-4b98-aefd-591440cf33d5","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d72a8130-9071-4b27-a120-a5e649be5f4f","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a85f43f2-618f-4809-ab85-1c9df81160e2","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-reply"},{"name":"create Reply","id":"v-create-reply","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/threads/:id/replies","description":"

Create a reply belonging to a thread.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateReplyRequest_datatrue
▹ attributesCreateReplyRequest_data_attributestrue
▹▹ isDraftingbooleanfalse
▹▹ referenceanyfalse
▹▹▹ anonymousCreateSceneReferencefalseA reference to a scene to be created for a thread.
▹▹▹▹ positionVector3false3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ sceneIdstring(uuid)trueID of the resource.
▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹ typeenum(scene-reference)true
▹▹▹▹ withSceneViewStateanyfalse
▹▹▹▹▹ anonymousWithSceneViewIdfalseA sceneViewId to be associated as a reference.
▹▹▹▹▹▹ sceneViewIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(scene-view-id)true
▹▹▹▹▹▹ withCanvasWithCanvasfalse
▹▹▹▹▹▹▹ documentCanvasDocumenttrue
▹▹▹▹▹▹▹▹ items[oneOf]true
▹▹▹▹▹▹▹▹▹ anonymousLineItem2dfalse
▹▹▹▹▹▹▹▹▹▹ endPositionVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹▹▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹▹▹▹▹▹ endShapeanyfalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousArrowEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹▹ filledbooleantrueIndicates if the arrow end should be filled.
▹▹▹▹▹▹▹▹▹▹▹▹ typeenum(arrow-end)true
▹▹▹▹▹▹▹▹▹▹▹▹ widthnumbertrueA numerical floating-point value.
▹▹▹▹▹▹▹▹▹▹▹ anonymousCircleEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹▹ diameternumbertrueA numerical floating-point value for the diameter of the end.
▹▹▹▹▹▹▹▹▹▹▹▹ filledbooleantrueIndicates if the circle end should be filled.
▹▹▹▹▹▹▹▹▹▹▹▹ typeenum(circle-end)true
▹▹▹▹▹▹▹▹▹▹▹ anonymousDashEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹▹ typeenum(dash-end)true
▹▹▹▹▹▹▹▹▹▹▹▹ widthnumbertrueA numerical floating-point value indicating the width of the dash.
▹▹▹▹▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹▹▹▹▹ colorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹▹▹ ainteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹ startPositionVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ startShapeanyfalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousArrowEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousCircleEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousDashEndShapefalse
▹▹▹▹▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹▹▹▹▹ colorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹▹ thicknessnumbertrueA numerical floating-point value.
▹▹▹▹▹▹▹▹▹▹ typeenum(line-item-2d)true
▹▹▹▹▹▹▹▹▹ anonymousOvalItem2dfalse
▹▹▹▹▹▹▹▹▹▹ bottomRightVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹▹▹▹ topLeftVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ typeenum(oval-item-2d)true
▹▹▹▹▹▹▹▹▹ anonymousFreeformItem2dfalse
▹▹▹▹▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹▹▹▹ positions[Vector2]true[2D Vector.]
▹▹▹▹▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹▹▹▹ typeenum(freeform-item-2d)true
▹▹▹▹▹▹▹▹▹ anonymousCalloutItemfalse
▹▹▹▹▹▹▹▹▹▹ accentColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ anchorPositionVector3true3D vector.
▹▹▹▹▹▹▹▹▹▹ primaryColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹▹▹▹▹ textPositionVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ typeenum(callout-item)true
▹▹▹▹▹▹▹▹▹ anonymousPinItem2dfalse
▹▹▹▹▹▹▹▹▹▹ accentColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ positionVector3true3D vector.
▹▹▹▹▹▹▹▹▹▹ primaryColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹▹▹▹▹ typeenum(pin-item-2d)true
▹▹▹▹▹▹▹▹ typeenum(canvas-document-3d-v1, canvas-document-v1)true
▹▹▹▹▹▹▹ suppliedIdstringfalse
▹▹▹▹▹▹▹ typeenum(with-canvas)true
▹▹▹▹▹ anonymousWithSceneViewStateIdfalseA sceneViewStateId to be associated as a reference.
▹▹▹▹▹▹ sceneViewStateIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(scene-view-state-id)true
▹▹▹ anonymousCreateDocumentReferencefalseA reference to a document to be created for a thread or reply.
▹▹▹▹ documentAnnotationCreateDocumentAnnotationfalseDocument annotation used when creating a document reference.
▹▹▹▹▹ contentPdfMarkuptrueThe content of the document annotation.
▹▹▹▹▹▹ canvasCanvasDocument2dtrue
▹▹▹▹▹▹▹ items[oneOf]true
▹▹▹▹▹▹▹▹ anonymousLineItem2dfalse
▹▹▹▹▹▹▹▹ anonymousOvalItem2dfalse
▹▹▹▹▹▹▹▹ anonymousFreeformItem2dfalse
▹▹▹▹▹▹▹ typeenum(canvas-document-2d-v1)true
▹▹▹▹▹▹ pageNumberinteger(int32)true
▹▹▹▹▹▹ typeenum(pdf-markup)true
▹▹▹▹▹ typeenum(document-annotation)true
▹▹▹▹ documentIdstring(uuid)falseID of the resource.
▹▹▹▹ typeenum(document-reference)true
▹▹ withBodyDocumentWithBodyDocumentfalse
▹▹▹ documentTextDocumenttrue
▹▹▹▹ rootRootNodetrue
▹▹▹▹▹ content[oneOf]trueList of nodes
▹▹▹▹▹▹ content[oneOf]trueList of paragraph nodes
▹▹▹▹▹▹▹ anonymousTextNodefalse
▹▹▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹▹▹ typeenum(text-node)true
▹▹▹▹▹▹▹ anonymousMentionNodefalse
▹▹▹▹▹▹▹▹ typeenum(mention-node)true
▹▹▹▹▹▹▹▹ userIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(paragraph-node)true
▹▹▹▹▹ typeenum(root-node)true
▹▹▹▹ typeenum(text-document-v1)true
▹▹▹ typeenum(with-body-document)true
▹ typeenum(reply)trueResource object type.
\n
","urlObject":{"path":["threads",":id","replies"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"c8f5bcaf-eebd-4154-99c4-2275b40bd8e0","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9175a0e6-36a6-4715-9776-af1433ab6022","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"6aa9981f-34de-4c6c-8a00-461955f4f8b7","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9806394d-b22f-475b-810a-0bd610876706","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-reply"}],"id":"v-replies","description":"

Requires Engage Module

\n","_postman_id":"v-replies"},{"name":"scene-alterations","item":[{"name":"get Queued Scene Alteration","id":"v-get-queued-scene-alteration","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-scene-alterations/:id","description":"

Get a queued-scene-alteration by ID.

\n","urlObject":{"path":["queued-scene-alterations",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-scene-alteration ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d3b40936-25dd-42ed-bce2-ec467e53188d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-alteration` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c7881af2-9cfb-4aae-9c06-d84eca5b2ae9","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-alteration` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"5b3c2c6b-ba91-415c-ac7d-c529053ab55f","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-alteration` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ecdb8830-d041-45c5-b630-a68126001501","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-alteration` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"42eaa3b2-db1a-48d7-8505-93d7f60086ed","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-alteration` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-scene-alteration"},{"name":"get Scene Alteration","id":"v-get-scene-alteration","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-alterations/:id","description":"

Get a scene-alteration by ID.

\n","urlObject":{"path":["scene-alterations",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-alteration ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"279893b6-3262-4dff-a637-f7507aec951d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-alteration` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1cab73d9-64d8-4a42-992d-6026145da868","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-alteration` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"88b1f418-3923-49db-98d3-8f4061ba1160","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-alteration` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c6f47254-18b2-4370-b86d-260f2af548f0","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-alteration` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-alteration"},{"name":"get Scene Alterations","id":"v-get-scene-alterations","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","description":"

Get scene-alterations for a scene-view.

\n","urlObject":{"path":["scene-views",":id","scene-alterations"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d001e859-a805-4250-b1c1-0c4d3f7e15b0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7943b322-0c32-4cbc-9440-dff2c1639093","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3c7e9a93-ec13-4b98-a576-3af88d066035","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b49c43b6-1297-4e31-8879-d5728248fca1","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-alterations"},{"name":"create Scene Alteration","id":"v-create-scene-alteration","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"alterations\": [\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n },\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n }\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","description":"

Create a scene-alteration for a scene-view.

\n","urlObject":{"path":["scene-views",":id","scene-alterations"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6ae59a5f-fa7f-4ac4-af0e-78514702b33f","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"alterations\": [\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n },\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n }\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"943bbaef-5009-49c6-ab3b-75a38f455824","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"alterations\": [\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n },\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n }\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"6cfafbc7-ffa5-44e9-be70-d42699722a9d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"alterations\": [\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n },\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n }\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"dbe63438-c9c8-45b3-af2e-d62b4ec9c2d2","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"alterations\": [\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n },\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n }\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c570e640-5911-476e-8a53-ea668c4af91b","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"alterations\": [\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n },\n {\n \"operations\": [\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n },\n {\n \"type\": \"change-visibility\",\n \"visible\": \"\"\n }\n ],\n \"query\": {\n \"data\": {\n \"attributes\": {\n \"type\": \"suppliedId\",\n \"value\": \"\"\n },\n \"type\": \"query-by-id\"\n }\n }\n }\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-alteration"}],"id":"v-scene-alterations","_postman_id":"v-scene-alterations","description":""},{"name":"scene-annotations","item":[{"name":"create Scene Annotation","id":"v-create-scene-annotation","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#591AB4\",\n \"icon\": \"\",\n \"primaryColor\": \"#8EcD29\"\n },\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-annotation-sets/:id/scene-annotations","description":"

Create an annotation belonging to an annotation set.\nPreview: This is a preview API and is subject to change.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneAnnotationRequest_datatrue
▹ attributesCreateSceneAnnotationRequest_data_attributestrue
▹▹ dataanytrueThe data describing how to render this annotation.
▹▹▹ anonymousSceneAnnotationCalloutDataTypefalseA type that describes a callout annotation.
▹▹▹▹ accentColorstringfalseA hex color value.
▹▹▹▹ iconstringfalseAn optional icon to display for this annotation. See documentation for possible values.
▹▹▹▹ positionVector3true3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ primaryColorstringfalseA hex color value.
▹▹▹▹ typestringtrueThe type of annotation.
▹▹▹ anonymousSceneAnnotationCustomDataTypefalseA type that describes a custom user provided annotation.
▹▹▹▹ jsonstringtrueAn encoded JSON string associated with the custom annotation.
▹▹▹▹ jsonTypestringtrueThe type of annotation.
▹▹▹▹ typestringtrueThe type of annotation.
▹▹ suppliedIdstringfalseA customer provided ID used for correlation.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-annotation-sets",":id","scene-annotations"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-annotation-set ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4001c33f-01b7-4864-9127-882943211556","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#591AB4\",\n \"icon\": \"\",\n \"primaryColor\": \"#8EcD29\"\n },\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-annotation-sets/:id/scene-annotations","host":["https://platform.vertexvis.com"],"path":["scene-annotation-sets",":id","scene-annotations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation-set` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#2271d8\",\n \"icon\": \"\",\n \"primaryColor\": \"#CaD455\"\n },\n \"modifiedAt\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"85f51d30-3d4f-4ee5-97c9-6c941f9ab303","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#591AB4\",\n \"icon\": \"\",\n \"primaryColor\": \"#8EcD29\"\n },\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-annotation-sets/:id/scene-annotations","host":["https://platform.vertexvis.com"],"path":["scene-annotation-sets",":id","scene-annotations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation-set` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-annotation"},{"name":"delete Scene Annotation","id":"v-delete-scene-annotation","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-annotations/:id","description":"

Delete a scene annotation.\nPreview: This is a preview API and is subject to change.

\n","urlObject":{"path":["scene-annotations",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-annotation ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e93e7e11-296d-420c-a781-33cf6b49d2f6","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-annotations/:id","host":["https://platform.vertexvis.com"],"path":["scene-annotations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"84b0337c-6f9a-4fa9-bf9e-7c3ebbb2a071","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-annotations/:id","host":["https://platform.vertexvis.com"],"path":["scene-annotations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c07cdc1f-27e7-41dd-a8de-79555be0ff99","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-annotations/:id","host":["https://platform.vertexvis.com"],"path":["scene-annotations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"774ba4d2-cac3-491b-90b5-2b4b83b00b87","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-annotations/:id","host":["https://platform.vertexvis.com"],"path":["scene-annotations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-scene-annotation"},{"name":"update Scene Annotation","id":"v-update-scene-annotation","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#6ABc4e\",\n \"icon\": \"\",\n \"primaryColor\": \"#6e19C3\"\n },\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-annotations/:id","description":"

Update the attributes of an annotation.\nPreview: This is a preview API and is subject to change.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateSceneAnnotationRequest_datatrue
▹ attributesUpdateSceneAnnotationRequest_data_attributestrue
▹▹ dataanyfalseThe data describing how to render this annotation.
▹▹▹ anonymousSceneAnnotationCalloutDataTypefalseA type that describes a callout annotation.
▹▹▹▹ accentColorstringfalseA hex color value.
▹▹▹▹ iconstringfalseAn optional icon to display for this annotation. See documentation for possible values.
▹▹▹▹ positionVector3true3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ primaryColorstringfalseA hex color value.
▹▹▹▹ typestringtrueThe type of annotation.
▹▹▹ anonymousSceneAnnotationCustomDataTypefalseA type that describes a custom user provided annotation.
▹▹▹▹ jsonstringtrueAn encoded JSON string associated with the custom annotation.
▹▹▹▹ jsonTypestringtrueThe type of annotation.
▹▹▹▹ typestringtrueThe type of annotation.
▹▹ suppliedIdstring¦nullfalseA customer provided ID used for correlation.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-annotations",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-annotation ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ac131612-20bf-423b-a40a-796e5d69c039","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#6ABc4e\",\n \"icon\": \"\",\n \"primaryColor\": \"#6e19C3\"\n },\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-annotations/:id","host":["https://platform.vertexvis.com"],"path":["scene-annotations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#2271d8\",\n \"icon\": \"\",\n \"primaryColor\": \"#CaD455\"\n },\n \"modifiedAt\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0051f7e1-125b-4766-928e-f393046c6834","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"data\": {\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"type\": \"\",\n \"accentColor\": \"#6ABc4e\",\n \"icon\": \"\",\n \"primaryColor\": \"#6e19C3\"\n },\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-annotations/:id","host":["https://platform.vertexvis.com"],"path":["scene-annotations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-annotation` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-scene-annotation"},{"name":"get Scene Annotation Sets","id":"v-get-scene-annotation-sets","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets?page[cursor]=&page[size]=&filter[id]=&filter[suppliedId]=","description":"

Get scene-annotation-sets for a scene.

\n","urlObject":{"path":["scenes",":id","scene-annotation-sets"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of IDs to filter on.

\n","type":"text/plain"},"key":"filter[id]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7c29fba4-a244-4ee7-a2dc-e74d52c956ca","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets?page[cursor]=&page[size]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ccf0c28c-9f60-4b41-bfa7-2b20f883cf67","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets?page[cursor]=&page[size]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7aeff482-0b40-4005-9e37-57a8198a78b5","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets?page[cursor]=&page[size]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"96ec328f-f904-4670-b38a-15bf4c1e4643","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets?page[cursor]=&page[size]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-annotation-sets"},{"name":"create Scene Annotation Set","id":"v-create-scene-annotation-set","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets","description":"

Create an annotation set that is associated with a scene.\nPreview: This is a preview API and is subject to change.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneAnnotationSetRequest_datatrue
▹ attributesCreateSceneAnnotationSetRequest_data_attributestrue
▹▹ namestringfalse
▹▹ suppliedIdstringfalseA customer provided ID used for correlation.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id","scene-annotation-sets"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4b278481-2189-44c8-9af1-3c729f4046f4","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"45928161-2373-4956-bc4a-0b1f54616cc7","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-annotation-set"}],"id":"v-scene-annotations","_postman_id":"v-scene-annotations","description":""},{"name":"scene-item-overrides","item":[{"name":"delete Scene Item Override","id":"v-delete-scene-item-override","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-item-overrides/:id","description":"

Delete a scene-item-override.

\n","urlObject":{"path":["scene-item-overrides",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-item-override ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"54467a5f-cab3-4df5-8ef5-6a2b73866235","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"93d28992-2193-46e0-997a-c854f45562d0","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5e0f898d-6a0e-4449-bd46-a1b3ab94d943","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9391d89a-062f-4392-a647-3a27456d3458","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-scene-item-override"},{"name":"update Scene Item Override","id":"v-update-scene-item-override","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-item-overrides/:id","description":"

Update a scene-item-override.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateSceneItemOverrideRequest_datatrue
▹ attributesUpdateSceneItemOverrideRequest_data_attributestrue
▹▹ endItemboolean¦nullfalse
▹▹ materialColorMaterialNullable¦nullfalseColor properties describing how a material looks.
▹▹▹ ambientColor3trueRGB color.
▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹ diffuseColor3trueRGB color.
▹▹▹ emissiveColor3trueRGB color.
▹▹▹ glossinessinteger(int32)trueGlossiness from 0 to 128.
▹▹▹ opacityinteger(int32)trueAn opacity value from 0 to 255.
▹▹▹ specularColor3trueRGB color.
▹▹ phantomboolean¦nullfalse
▹▹ selectedboolean¦nullfalse
▹▹ transformMatrix4Nullable¦nullfalse4x4 affine transformation matrix, see Matrix transformations for details.
▹▹▹ r0Vector4true4D vector.
▹▹▹▹ wnumbertruew value.
▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹ r1Vector4true4D vector.
▹▹▹ r2Vector4true4D vector.
▹▹▹ r3Vector4true4D vector.
▹▹ visibleboolean¦nullfalseItem visibility.
▹ idstring(uuid)trueID of the resource.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-item-overrides",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-item-override ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8a5830a3-c1e5-40cc-b986-e3aba41d129c","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"cf92d95c-1990-4b40-b0c1-bec3131e2b76","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"89d9f31b-c880-4dcd-9530-8533e194bd06","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9bc6408e-3026-4a36-8716-6f45b5affea5","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"35977307-a66a-4255-affa-b8af798a4e4a","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-item-overrides/:id","host":["https://platform.vertexvis.com"],"path":["scene-item-overrides",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item-override` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-scene-item-override"},{"name":"get Scene Item Overrides","id":"v-get-scene-item-overrides","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides?page[cursor]=&page[size]=","description":"

Get scene-item-overrides for a scene-view.

\n","urlObject":{"path":["scene-views",":id","scene-item-overrides"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f2ed31b7-7613-4772-bd26-a7e06a0ccf9a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"dae55405-ee30-4db8-b14f-34e5fdcfd274","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"8f9db55f-79b1-4a01-ba53-a8af02d1f022","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b440ca25-9a7d-4774-89c6-cc246eea50c3","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-item-overrides"},{"name":"create Scene Item Override","id":"v-create-scene-item-override","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides","description":"

Create a scene-item-override for a scene-view.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneItemOverrideRequest_datatrue
▹ attributesCreateSceneItemOverrideRequest_data_attributestrue
▹▹ endItembooleanfalseWhether this item is an end item.
▹▹ materialColorMaterialfalseColor properties describing how a material looks.
▹▹▹ ambientColor3trueRGB color.
▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹ diffuseColor3trueRGB color.
▹▹▹ emissiveColor3trueRGB color.
▹▹▹ glossinessinteger(int32)trueGlossiness from 0 to 128.
▹▹▹ opacityinteger(int32)trueAn opacity value from 0 to 255.
▹▹▹ specularColor3trueRGB color.
▹▹ phantombooleanfalsePhantom state of the item.
▹▹ selectedbooleanfalse
▹▹ transformMatrix4false4x4 affine transformation matrix.
▹▹▹ r0Vector4true4D vector.
▹▹▹▹ wnumbertruew value.
▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹ r1Vector4true4D vector.
▹▹▹ r2Vector4true4D vector.
▹▹▹ r3Vector4true4D vector.
▹▹ visiblebooleanfalseItem visibility.
▹ relationshipsCreateSceneItemOverrideRequest_data_relationshipstrue
▹▹ sceneItemSceneItemRelationshiptrueRelationship to a scene-item.
▹▹▹ dataSceneItemRelationship_datatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene-item)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-views",":id","scene-item-overrides"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7055eedb-a61e-42f4-aeb7-6e496b0c583a","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e5bc27b6-6489-46a0-a4eb-f4c8a76d46d2","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"488c991d-d779-4ba4-9baa-680c52092384","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9b7e3b98-b39b-4717-ac3f-b29ad432d69c","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"eda75c92-557b-4dae-8626-30eaa7c2422f","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-item-overrides","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-item-overrides"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-item-override"}],"id":"v-scene-item-overrides","_postman_id":"v-scene-item-overrides","description":""},{"name":"scene-items","item":[{"name":"get Queued Scene Item Deletion","id":"get-queued-scene-item-deletion","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-scene-item-deletions/:id","description":"

Get a queued-scene-item-deletion by ID.

\n","urlObject":{"path":["queued-scene-item-deletions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-scene-item-deletion ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"430047e7-8250-4d97-b426-92573b75993f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-item-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-item-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item-deletion` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5c5ec54f-0bdd-4477-a804-e39ef729cc15","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-item-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-item-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item-deletion` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e859c824-6c5c-4369-a599-a54a8789b899","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-item-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-item-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item-deletion` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4aecc3c9-6de9-4008-860a-935d3f9491da","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-item-deletions/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-item-deletions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item-deletion` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-queued-scene-item-deletion"},{"name":"get Queued Scene Item","id":"v-get-queued-scene-item","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-scene-items/:id","description":"

Get a queued-scene-item. The response is either the status if running or error or, upon completion, redirects to the created scene-item. Once created, commit the scene via the updateScene API. For details, see our Render static scenes guide.

\n","urlObject":{"path":["queued-scene-items",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-scene-item ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e8e9839f-18bd-496d-b405-d8a34e6352f7","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-items/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3dcbe30a-01ec-47ed-87d2-edd279377f6a","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-items/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"e642fa04-b653-49b2-b73c-b05960dccc37","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-items/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"745f117c-70ac-473b-af32-e36474d7e367","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-items/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f7c4234d-edeb-4190-934c-ae6abf1792fc","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-items/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-scene-item"},{"name":"delete Scene Item","id":"v-delete-scene-item","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-items/:id","description":"

Delete a scene-item.

\n","urlObject":{"path":["scene-items",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-item ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"5a18e71f-a2bf-4b5b-bbac-8e93ccf00f67","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"19777a22-5db6-43a4-813c-13275922fb4b","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"84edfdb9-80de-4510-8249-3082142730d3","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"69a7dfa1-1615-442a-9680-c47b7fe80d83","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-scene-item"},{"name":"get Scene Item","id":"v-get-scene-item","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-items/:id?fields[scene-item]=","description":"

Get a scene-item by ID.

\n","urlObject":{"path":["scene-items",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. boundingBox, worldTransform and metadata are only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[scene-item]","value":""}],"variable":[{"description":{"content":"

(Required) The scene-item ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"af2559a0-2db3-4a50-a338-c3781cea3980","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id?fields[scene-item]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"38506da3-1ee2-4dc9-93fd-c0ef70eccba8","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id?fields[scene-item]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d89ad642-9ecf-4fac-9d21-980169480218","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id?fields[scene-item]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"58572530-dcbb-4dd1-8638-c39015e5258d","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-items/:id?fields[scene-item]=","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-item"},{"name":"update Scene Item","id":"v-update-scene-item","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-items/:id","description":"

Update a scene-item.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateSceneItemRequest_datatrue
▹ attributesUpdateSceneItemRequest_data_attributestrue
▹▹ endItembooleanfalseWhether this item is an end item.
▹▹ materialOverrideMaterialOverridefalseColor material override.
▹▹▹ valueColorMaterialfalseColor properties describing how a material looks.
▹▹▹▹ ambientColor3trueRGB color.
▹▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹▹ diffuseColor3trueRGB color.
▹▹▹▹ emissiveColor3trueRGB color.
▹▹▹▹ glossinessinteger(int32)trueGlossiness from 0 to 128.
▹▹▹▹ opacityinteger(int32)trueAn opacity value from 0 to 255.
▹▹▹▹ specularColor3trueRGB color.
▹▹ metadataobjectfalseAdditional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
▹▹▹ additionalPropertiesanyfalse
▹▹▹▹ anonymousMetadataLongTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valueinteger(int64)trueA numerical long value.
▹▹▹▹ anonymousMetadataFloatTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuenumber(float)trueA numerical floating-point value.
▹▹▹▹ anonymousMetadataDateTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestring(date-time)trueA date value.
▹▹▹▹ anonymousMetadataStringTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestringtrueA string value.
▹▹▹▹ anonymousMetadataNullTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹ namestringfalse
▹▹ phantombooleanfalsePhantom state of the item.
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ transformMatrix4false4x4 affine transformation matrix.
▹▹▹ r0Vector4true4D vector.
▹▹▹▹ wnumbertruew value.
▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹ r1Vector4true4D vector.
▹▹▹ r2Vector4true4D vector.
▹▹▹ r3Vector4true4D vector.
▹▹ visiblebooleanfalseItem visibility.
▹ relationshipsUpdateSceneItemRequest_data_relationshipsfalse
▹▹ sourceanyfalseRelationship to a geometry-set or part-revision.
▹▹▹ anonymousGeometrySetRelationshipfalseRelationship to a geometry-set.
▹▹▹▹ dataGeometrySetRelationshipDatatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(geometry-set)trueResource object type.
▹▹▹ anonymousPartRevisionRelationshipfalseRelationship to a part-revision.
▹▹▹▹ dataPartData_relationships_partRevisionstrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(part-revision)trueResource object type.
▹▹▹ anonymousNullableObject¦nullfalse
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-items",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-item ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"8f8d3a00-5fa5-4515-90d9-d44d2b82a65a","name":"Accepted","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5240e41f-2be3-4112-96b2-504618481e2d","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0a70844d-5537-4270-8864-fbeacaf51adf","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"87776338-93f5-4223-89c8-3ad84da35a51","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a3426ea9-19b5-4e1f-9403-2e826212e6ca","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-scene-item"},{"name":"get Scene Items","id":"v-get-scene-items","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","description":"

Get scene-items for a scene.

\n","urlObject":{"path":["scenes",":id","scene-items"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Source ID to filter on.

\n","type":"text/plain"},"key":"filter[source]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""},{"description":{"content":"

Parent ID to filter on. Sending null will return items without a parent.

\n","type":"text/plain"},"key":"filter[parent]","value":""},{"description":{"content":"

Filter scene-items based on whether they are the parent of at least one other scene-item

\n","type":"text/plain"},"key":"filter[hasChildren]","value":""},{"description":{"content":"

Filter scene-items based on whether they have an associated geometry-set.

\n","type":"text/plain"},"key":"filter[hasGeometrySet]","value":""},{"description":{"content":"

A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"27791bca-a90a-4bbb-adf7-39cf7b782bab","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"54fce173-4819-4daf-b8cb-ceb5dcd4fd95","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b56ee12c-0ea1-44ba-894d-06337d4f6ab1","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"64ae7808-d538-44c5-91e6-737315435f70","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-items"},{"name":"create Scene Item","id":"v-create-scene-item","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/scene-items","description":"

Create a scene-item for a scene. Provide the source geometry either via part-revision or geometry-set UUID using relationship.source or by supplied IDs using attributes.source.\nProvide an existing scene using relationship.source to clone it.\nProvide the hierarchical parent either via scene-item UUID using relationship.source or by supplied ID using attributes.parent. To reduce the time taken creating many hierarchical scene-items, make a best effort to create parents before children. One way to do this is by sorting the items by depth and starting at the root.\nThis API is asynchronous, returning the location of a queued-scene-item. Check the status via the getQueuedSceneItem API. For details, see our Render static scenes guide.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneItemRequestDatatrue
▹ attributesCreateSceneItemRequestData_attributestrue
▹▹ endItembooleanfalseWhether this item is an end item.
▹▹ experimentalSourceMetadataKeys[string]falseSpecifies which metadata keys should be copied from the source item. Sending null will default to all keys. Sending an empty string will copy none of the sources' metadata. Sending an array of [\"KEY1\", \"KEY2] will include KEY1 and KEY2 from the source in the scene item creation. This is marked experimental since future releases are expected to prevent copying metadata entirely.
▹▹ materialOverrideColorMaterialfalseColor properties describing how a material looks.
▹▹▹ ambientColor3trueRGB color.
▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹ diffuseColor3trueRGB color.
▹▹▹ emissiveColor3trueRGB color.
▹▹▹ glossinessinteger(int32)trueGlossiness from 0 to 128.
▹▹▹ opacityinteger(int32)trueAn opacity value from 0 to 255.
▹▹▹ specularColor3trueRGB color.
▹▹ metadataobjectfalseAdditional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
▹▹▹ additionalPropertiesanyfalse
▹▹▹▹ anonymousMetadataLongTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valueinteger(int64)trueA numerical long value.
▹▹▹▹ anonymousMetadataFloatTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuenumber(float)trueA numerical floating-point value.
▹▹▹▹ anonymousMetadataDateTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestring(date-time)trueA date value.
▹▹▹▹ anonymousMetadataStringTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹▹▹▹ valuestringtrueA string value.
▹▹▹▹ anonymousMetadataNullTypefalse
▹▹▹▹▹ typestringtrueType of metadata value.
▹▹ namestringfalse
▹▹ ordinalintegerfalseA 0-based index used for defining a consistent ordering amongst sibling scene items.
▹▹ parentstringfalseOptional ability to specify a parent scene item by scene item supplied ID. For example, an existing ID from a PLM system. This approach is an alternative to providing a specific scene item ID with the relationship parent property.
▹▹ partInstanceSuppliedIdsAsSuppliedIdsbooleanfalseWhether or not to use part instance supplied IDs as scene item supplied IDs.
▹▹ phantombooleanfalsePhantom state of the item.
▹▹ resolutionRuleenum(as-specified, latest-iteration, latest-revision)falseOptional rule to guide the part-revision resolution algorithm in cases where required qualifiers are not explicitly specified by the query. In the case of assembly parts, the resolution rule also applies recursively to the resolution of the child parts.
▹▹ sourcePartRevisionSuppliedIdfalse
▹▹▹ suppliedIterationIdstringfalseOptional iteration ID for the revision. For example, a generated version id from a PLM system to a specific revision. Used when a existing revision is modified.
▹▹▹ suppliedPartIdstringtrueID provided for correlation. For example, an existing ID from a PLM system.
▹▹▹ suppliedRevisionIdstringtrueID provided for correlation. For example, an existing ID from a PLM system.
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ transformMatrix4false4x4 affine transformation matrix.
▹▹▹ r0Vector4true4D vector.
▹▹▹▹ wnumbertruew value.
▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹ r1Vector4true4D vector.
▹▹▹ r2Vector4true4D vector.
▹▹▹ r3Vector4true4D vector.
▹▹ visiblebooleanfalseItem visibility.
▹ relationshipsCreateSceneItemRequestData_relationshipstrue
▹▹ parentSceneItemRelationshipfalseRelationship to a scene-item.
▹▹▹ dataSceneItemRelationship_datatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene-item)trueResource object type.
▹▹ referenceTreeSceneItemRelationshipfalseRelationship to a scene-item.
▹▹ sourceanyfalseRelationship to a geometry-set, part-revision, part-rendition, or scene.
▹▹▹ anonymousGeometrySetRelationshipfalseRelationship to a geometry-set.
▹▹▹▹ dataGeometrySetRelationshipDatatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(geometry-set)trueResource object type.
▹▹▹ anonymousPartRevisionRelationshipfalseRelationship to a part-revision.
▹▹▹▹ dataPartData_relationships_partRevisionstrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(part-revision)trueResource object type.
▹▹▹ anonymousSceneRelationshipfalseRelationship to a scene.
▹▹▹▹ dataSceneRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(scene)trueResource object type.
▹▹▹ anonymousPartRenditionRelationshipfalseRelationship to a part-rendition.
▹▹▹▹ dataPartRenditionRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(part-rendition)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id","scene-items"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"53f586c5-af45-4578-9393-b98cc055ab6a","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9b5813d4-a18c-463a-961e-3bc35784b891","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4f5e443f-dac7-4b44-938c-c8b24ddb0c20","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a7043948-74b6-4de1-8d44-b82385a6bffc","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c57480d7-46fb-49f0-a49d-56bc595e0961","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"14d1a21a-5de6-4831-af23-5a415757e2a4","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-item"}],"id":"v-scene-items","_postman_id":"v-scene-items","description":""},{"name":"scene-synchronizations","item":[{"name":"get Queued Scene Sync","id":"v-get-queued-scene-sync","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-scene-syncs/:id","description":"

Get a queued-scene-sync-job.

\n","urlObject":{"path":["queued-scene-syncs",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-scene-sync ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"30b6f3bf-14a2-439a-8c28-b955318f45cd","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-sync` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"eabd0f6e-64b0-4469-b030-bed11edc7cf5","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-sync` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b07c2771-0763-4979-8c4c-07f0ae9eeb74","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-sync` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"942d86c4-8db0-4d9f-9d02-2ea381c0d22b","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-sync` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-scene-sync"},{"name":"get Scene Sync","id":"v-get-scene-sync","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-syncs/:id","description":"

Get a scene-sync.

\n","urlObject":{"path":["scene-syncs",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-sync ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"55c05e53-98e3-4a11-9cce-21e094339ac1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"completedAt\": \"\",\n \"created\": \"\",\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0474eed1-5fac-4072-8b63-2a1fe5c93e53","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f00cbb9e-b844-42f4-9416-fcd13aa7a15c","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"582bd475-baac-4ca9-a688-66cc0e2feb32","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-sync"},{"name":"get Scene Sync Item Results","id":"get-scene-sync-item-results","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-syncs/:id/item-results?page[cursor]=&page[size]=&filter[sceneItemId]=","description":"

Get the results of a scene synchronization.

\n","urlObject":{"path":["scene-syncs",":id","item-results"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

List of scene item IDs to filter on.

\n","type":"text/plain"},"key":"filter[sceneItemId]","value":""}],"variable":[{"description":{"content":"

(Required) The scene-sync ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f6464625-217a-4ad5-95cd-c6ad94c237c8","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id/item-results?page[cursor]=&page[size]=&filter[sceneItemId]=","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id","item-results"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"List of scene item IDs to filter on.","key":"filter[sceneItemId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"status\": \"\",\n \"error\": {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"status\": \"\",\n \"error\": {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fb200af1-25d8-4932-8207-06f96177f846","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id/item-results?page[cursor]=&page[size]=&filter[sceneItemId]=","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id","item-results"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"List of scene item IDs to filter on.","key":"filter[sceneItemId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2cac5f2e-37c0-4571-9356-3ec1f2484cdc","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id/item-results?page[cursor]=&page[size]=&filter[sceneItemId]=","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id","item-results"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"List of scene item IDs to filter on.","key":"filter[sceneItemId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7d24c377-efbf-473e-8703-db5274c6e61b","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-syncs/:id/item-results?page[cursor]=&page[size]=&filter[sceneItemId]=","host":["https://platform.vertexvis.com"],"path":["scene-syncs",":id","item-results"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"List of scene item IDs to filter on.","key":"filter[sceneItemId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-sync` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-scene-sync-item-results"},{"name":"create Scene Sync","id":"v-create-scene-sync","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"operation\": {\n \"revisionId\": \"\",\n \"type\": \"update-to-default-rendition\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/scene-syncs","description":"

Create a scene item update job.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
operationUpdateItemToDefaultRenditionOperationtrueAn operation that updates items with the specified revision to the default rendition.
▹ revisionIdstring(uuid)trueID of the resource.
▹ typeenum(update-to-default-rendition)true
\n
","urlObject":{"path":["scenes",":id","scene-syncs"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"71576991-f7fc-416a-a028-3b328ffc1e88","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"operation\": {\n \"revisionId\": \"\",\n \"type\": \"update-to-default-rendition\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-syncs","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-syncs"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"10c61b6e-09ec-48dc-bd88-a1438bc1bb21","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"operation\": {\n \"revisionId\": \"\",\n \"type\": \"update-to-default-rendition\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-syncs","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-syncs"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-sync"}],"id":"v-scene-synchronizations","_postman_id":"v-scene-synchronizations","description":""},{"name":"scene-views","item":[{"name":"delete Scene View","id":"v-delete-scene-view","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-views/:id","description":"

Delete a scene-view.

\n","urlObject":{"path":["scene-views",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"24495633-23ed-4971-92c5-ad998712f124","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"68ed6f67-a5ae-4d43-bc76-b6185eb190cc","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b048aad3-7ff1-422e-88a7-001f932320bb","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"309f0858-3d0d-46ed-b369-8d17346ca07d","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-scene-view"},{"name":"get Scene View","id":"v-get-scene-view","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-views/:id","description":"

Get a scene-view by ID.

\n","urlObject":{"path":["scene-views",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"7c0c8d6c-cc64-4db4-96bd-edd483a451d1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ccd6e9df-f7b4-4fa2-b87a-9b238b69a3ac","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9790cf9c-41e2-4b57-8e92-a154d23117b1","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"1d6782c5-bf5a-4176-8382-52feaf7e082f","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-view"},{"name":"update Scene View","id":"v-update-scene-view","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-views/:id","description":"

Update a scene-view.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateSceneViewRequest_datatrue
▹ attributesUpdateSceneViewRequest_data_attributestrue
▹▹ cameraanyfalse
▹▹▹ anonymousPerspectiveCamerafalseA camera type that mimics the way the human eye sees.
▹▹▹▹ fovYnumberfalseA numerical floating-point value representing the field of view
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ positionVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹ anonymousOrthographicCamerafalseA camera type where an object's size stays consistent regardless of its distance to the camera.
▹▹▹▹ fovHeightnumbertrue
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹▹ viewVectorVector3true3D vector.
▹▹▹ anonymousCameraFitfalseFit camera in 3D space based on items in scene.
▹▹▹▹ typeenum(fit-visible-scene-items, reset)trueResource object type.
▹▹ crossSectioningCrossSectioning¦nullfalse
▹▹▹ planes[SectionPlane]true
▹▹▹▹ normalVector3true3D vector.
▹▹▹▹ offsetnumbertrueDistance from the center point to move the plane.
▹▹ noDefaultLightsbooleanfalseWhether or not to turn off default lighting
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-views",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0719d484-90aa-41e0-b50b-aac50f611e2a","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8d5c37d4-c96c-4923-810c-5d027ed3ee7d","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"6ffc17f4-6e4f-4785-8048-74c2ba487dc4","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0d4a2002-36d8-4ec5-a276-449290f14476","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"fc5b114f-82eb-4d09-b1cb-5cb969780ecc","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-scene-view"},{"name":"render Scene View","id":"v-render-scene-view","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"image/jpeg"}],"url":"https://platform.vertexvis.com/scene-views/:id/image?height=&width=","description":"

Get a rendered image of a scene-view. If a single pixel is returned, ensure the scene is in the commit state and contains scene items.

\n","urlObject":{"path":["scene-views",":id","image"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The height of the image to render.

\n","type":"text/plain"},"key":"height","value":""},{"description":{"content":"

The width of the image to render.

\n","type":"text/plain"},"key":"width","value":""}],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"2d448841-6335-4f64-b5b0-23c4c624abea","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"image/jpeg"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"image/jpeg"}],"cookie":[],"responseTime":null,"body":""},{"id":"b5cb9f9a-9b7e-4e89-84c1-e9108e90812e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9559c84c-6ea0-484d-80c3-bf46238ca4d4","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7b1d8d64-25fb-4d15-ae40-0d6ec90fc975","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"59da996e-7e6d-46f5-8710-f10a5aed87a6","name":"GatewayTimeout","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-render-scene-view"},{"name":"get View Scene Item","id":"v-get-view-scene-item","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-views/:id/scene-items/:itemId?fields[scene-item]=&include=","description":"

Get a scene-item within a view by ID.

\n","urlObject":{"path":["scene-views",":id","scene-items",":itemId"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. boundingBox, worldTransform and metadata are only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[scene-item]","value":""},{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""}],"variable":[{"description":{"content":"

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"},{"description":{"content":"

(Required) The scene-item ID.

\n","type":"text/plain"},"type":"any","value":"","key":"itemId"}]}},"response":[{"id":"eb91531d-4ee0-4ac5-a4ac-a35a8e3f06e1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-items/:itemId?fields[scene-item]=&include=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-items",":itemId"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."},{"key":"itemId","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"805722f6-e461-4d63-9db8-5d44fe78e3aa","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-items/:itemId?fields[scene-item]=&include=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-items",":itemId"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."},{"key":"itemId","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a7e49fb0-7ca3-4d36-a455-667259365b87","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-items/:itemId?fields[scene-item]=&include=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-items",":itemId"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."},{"key":"itemId","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"bcf57249-6b3b-42d8-b896-a1a35aaf06a5","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-items/:itemId?fields[scene-item]=&include=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-items",":itemId"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."},{"key":"itemId","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-view-scene-item"},{"name":"get Scene Views","id":"v-get-scene-views","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes/:id/scene-views?page[cursor]=&page[size]=","description":"

Get scene-views for a scene.

\n","urlObject":{"path":["scenes",":id","scene-views"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"33e379b8-47ce-4105-b119-96e51d82e16f","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"12c48a70-5278-426c-967f-f6d6d50c18b2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2025715a-d904-450f-bf06-c7b28e2eec1d","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-views"},{"name":"create Scene View","id":"v-create-scene-view","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/scene-views","description":"

Create a scene-view of a scene.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneViewRequest_datatrue
▹ attributesCreateSceneViewRequest_data_attributestrue
▹▹ cameraanyfalse
▹▹▹ anonymousPerspectiveCamerafalseA camera type that mimics the way the human eye sees.
▹▹▹▹ fovYnumberfalseA numerical floating-point value representing the field of view
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ positionVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹ anonymousOrthographicCamerafalseA camera type where an object's size stays consistent regardless of its distance to the camera.
▹▹▹▹ fovHeightnumbertrue
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹▹ viewVectorVector3true3D vector.
▹▹ crossSectioningCrossSectioning¦nullfalse
▹▹▹ planes[SectionPlane]true
▹▹▹▹ normalVector3true3D vector.
▹▹▹▹ offsetnumbertrueDistance from the center point to move the plane.
▹▹ excludePrunedItemsbooleanfalseWhether to exclude non-visible items in the view
▹▹ expiryintegerfalseNumber of seconds before expiration. Defaults to 24 hours in seconds. Max is 7 days in seconds
▹ relationshipsCreateSceneViewRequest_data_relationshipsfalse
▹▹ sceneViewStateSceneViewStateRelationshipfalseRelationship to a scene-view-state.
▹▹▹ dataSceneViewStateRelationship_datatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene-view-state)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id","scene-views"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"d5c298e3-8907-4e4b-aeac-85ee92497f27","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1d5c51fc-e461-4336-b904-ddc57dc877e8","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d80ca931-b0fd-4080-93c5-6b6fd8accb9d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3fd7b861-a998-4b95-94b9-8d99c8adc7c9","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2de5faa9-7241-43dc-90d6-8bdcd3533097","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-view"}],"id":"v-scene-views","_postman_id":"v-scene-views","description":""},{"name":"scenes","item":[{"name":"get Queued Scene","id":"v-get-queued-scene","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-scenes/:id","description":"

Get a queued-scene.

\n","urlObject":{"path":["queued-scenes",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"01eea5e8-130d-4b68-8185-946ca97eab94","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scenes/:id","host":["https://platform.vertexvis.com"],"path":["queued-scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1a7dc720-16f1-4c5e-9ea3-532bdfc9e8f8","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scenes/:id","host":["https://platform.vertexvis.com"],"path":["queued-scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"6fd74d24-7e9d-42a4-8467-61378b9e838d","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scenes/:id","host":["https://platform.vertexvis.com"],"path":["queued-scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"70ee0d1e-6c3f-4bcc-af8d-14baa86776f4","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scenes/:id","host":["https://platform.vertexvis.com"],"path":["queued-scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"01500559-ebb9-45be-b82f-50682bdd8439","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-scenes/:id","host":["https://platform.vertexvis.com"],"path":["queued-scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-scene"},{"name":"get Scenes","id":"v-get-scenes","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&fields[scene]=&key_0=&key_1=&key_2=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","description":"

Get scenes.

\n","urlObject":{"path":["scenes"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

A filter for the name. The canonical form is a filter expression such as filter[name][contains]=.... The deprecated legacy filter[name]=name-1,name-2 exact-match CSV form is also accepted for backwards compatibility.

\n","type":"text/plain"},"key":"filter[name]","value":"7536"},{"description":{"content":"

A filter for the suppliedId. The canonical form is a filter expression such as filter[suppliedId][contains]=.... The deprecated legacy filter[suppliedId]=id-1,id-2 exact-match CSV form is also accepted for backwards compatibility.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":"7536"},{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. metadata is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[scene]","value":""},{"description":{"content":"

Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: filter[metadata][key1]=value1&filter[metadata][key]=value2.

\n","type":"text/plain"},"key":"key_0","value":""},{"description":{"content":"

Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: filter[metadata][key1]=value1&filter[metadata][key]=value2.

\n","type":"text/plain"},"key":"key_1","value":""},{"description":{"content":"

Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: filter[metadata][key1]=value1&filter[metadata][key]=value2.

\n","type":"text/plain"},"key":"key_2","value":""},{"description":{"content":"

Comma-separated list of scene-item source part revision IDs to filter on.

\n","type":"text/plain"},"key":"filter[sceneItems.source.partRevision]","value":""},{"description":{"content":"

Comma-separated list of scene-item source geometry set IDs to filter on.

\n","type":"text/plain"},"key":"filter[sceneItems.source.geometrySet]","value":""},{"description":{"content":"

Comma-separated list of scene-item source scene IDs to filter on.

\n","type":"text/plain"},"key":"filter[sceneItems.source.scene]","value":""}],"variable":[]}},"response":[{"id":"7c72d2ae-5306-47ad-bfa7-670db178b8d2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&fields[scene]=&key_0=&key_1=&key_2=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","host":["https://platform.vertexvis.com"],"path":["scenes"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[name]","value":"7536"},{"description":"A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[suppliedId]","value":"7536"},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.","key":"fields[scene]","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_0","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_1","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_2","value":""},{"description":"Comma-separated list of scene-item source part revision IDs to filter on.","key":"filter[sceneItems.source.partRevision]","value":""},{"description":"Comma-separated list of scene-item source geometry set IDs to filter on.","key":"filter[sceneItems.source.geometrySet]","value":""},{"description":"Comma-separated list of scene-item source scene IDs to filter on.","key":"filter[sceneItems.source.scene]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"287b08ed-f481-4288-86c3-ecd15c426854","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&fields[scene]=&key_0=&key_1=&key_2=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","host":["https://platform.vertexvis.com"],"path":["scenes"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[name]","value":"7536"},{"description":"A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[suppliedId]","value":"7536"},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.","key":"fields[scene]","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_0","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_1","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_2","value":""},{"description":"Comma-separated list of scene-item source part revision IDs to filter on.","key":"filter[sceneItems.source.partRevision]","value":""},{"description":"Comma-separated list of scene-item source geometry set IDs to filter on.","key":"filter[sceneItems.source.geometrySet]","value":""},{"description":"Comma-separated list of scene-item source scene IDs to filter on.","key":"filter[sceneItems.source.scene]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7c57307e-4812-43d6-acea-050f43b6c8eb","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes?page[cursor]=&page[size]=&filter[name]=7536&filter[suppliedId]=7536&fields[scene]=&key_0=&key_1=&key_2=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","host":["https://platform.vertexvis.com"],"path":["scenes"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[name]","value":"7536"},{"description":"A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.","key":"filter[suppliedId]","value":"7536"},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.","key":"fields[scene]","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_0","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_1","value":""},{"description":"Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.\n","key":"key_2","value":""},{"description":"Comma-separated list of scene-item source part revision IDs to filter on.","key":"filter[sceneItems.source.partRevision]","value":""},{"description":"Comma-separated list of scene-item source geometry set IDs to filter on.","key":"filter[sceneItems.source.geometrySet]","value":""},{"description":"Comma-separated list of scene-item source scene IDs to filter on.","key":"filter[sceneItems.source.scene]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scenes"},{"name":"create Scene","id":"v-create-scene","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes","description":"

Create a scene. Once created, add scene items via the createSceneItem API. For details, see our Render static scenes guide.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneRequest_datatrue
▹ attributesCreateSceneRequest_data_attributestrue
▹▹ cameraanyfalse
▹▹▹ anonymousPerspectiveCamerafalseA camera type that mimics the way the human eye sees.
▹▹▹▹ fovYnumberfalseA numerical floating-point value representing the field of view
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ positionVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹ anonymousOrthographicCamerafalseA camera type where an object's size stays consistent regardless of its distance to the camera.
▹▹▹▹ fovHeightnumbertrue
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹▹ viewVectorVector3true3D vector.
▹▹ expiryinteger(int32)falseNumber of seconds before expiration
▹▹ metadataobjectfalseUser supplied key-value pairs for a scene. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters. A null value will delete the entry in the map, all other key/value pairs provided here will be inserted or updated into the existing scene metadata.
▹▹▹ additionalPropertiesstring¦nullfalse
▹▹ namestringfalse
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ treeEnabledbooleanfalse
▹▹ worldOrientationOrientationfalseNormals describing up & front directions
▹▹▹ frontVector3true3D vector.
▹▹▹ upVector3true3D vector.
▹ relationshipsCreateSceneRequest_data_relationshipsfalse
▹▹ sourceSceneRelationshiptrueRelationship to a scene.
▹▹▹ dataSceneRelationship_datatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"28ae64d5-f009-4560-a9b6-f9cd5a157641","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3bd0e1f3-ac4f-4481-932c-0898e2960b69","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f61a5854-9597-4077-a8c4-c21d60e6e25b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d6455f2a-264b-42d7-a89c-5f2f5e4633a2","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene"},{"name":"delete Scene","id":"v-delete-scene","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes/:id","description":"

Delete a scene.

\n","urlObject":{"path":["scenes",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"47b8ef86-53c8-4857-917f-bf184880fcff","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"b19e8fb9-f781-4b80-8ef2-d89448240d97","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"98c336a4-87f7-4d3f-a21d-69ba8fabd959","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5558bab0-92e0-4aea-b0dd-f3f372fc3529","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-scene"},{"name":"get Scene","id":"v-get-scene","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes/:id?fields[scene]=","description":"

Get a scene by ID.

\n","urlObject":{"path":["scenes",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. sceneItemCount and metadata are only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[scene]","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4648870b-1e46-4060-aa02-55b2f19eeda0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id?fields[scene]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.","key":"fields[scene]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"6b0c8ec7-a7e0-4e3f-81c1-77bff152545e","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id?fields[scene]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.","key":"fields[scene]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b1adae67-5045-4ecf-b22a-8c96e029b5b4","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id?fields[scene]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.","key":"fields[scene]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c673a8f3-3e4d-4bd1-bece-c3b3a47bb8d3","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id?fields[scene]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.","key":"fields[scene]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene"},{"name":"update Scene","id":"v-update-scene","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id","description":"

Update a scene camera and/or state. Once updated, view the scene via the renderScene API or with the Viewer SDK. For details, see our Render static scenes guide.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateSceneRequest_datatrue
▹ attributesUpdateSceneRequest_data_attributestrue
▹▹ cameraanyfalse
▹▹▹ anonymousPerspectiveCamerafalseA camera type that mimics the way the human eye sees.
▹▹▹▹ fovYnumberfalseA numerical floating-point value representing the field of view
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ positionVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹ anonymousOrthographicCamerafalseA camera type where an object's size stays consistent regardless of its distance to the camera.
▹▹▹▹ fovHeightnumbertrue
▹▹▹▹ lookAtVector3true3D vector.
▹▹▹▹ typestringfalse
▹▹▹▹ upVector3true3D vector.
▹▹▹▹ viewVectorVector3true3D vector.
▹▹▹ anonymousCameraFitfalseFit camera in 3D space based on items in scene.
▹▹▹▹ typeenum(fit-visible-scene-items, reset)trueResource object type.
▹▹ expiryinteger(int32)falseNumber of seconds before expiration
▹▹ metadataobjectfalseUser supplied key-value pairs for a scene. You can supply up to 50 entries, with key names limited to 64 characters and values limited to 256 characters. A null value will delete the entry in the map, all other key/value pairs provided here will be inserted or updated into the existing scene metadata.
▹▹▹ additionalPropertiesstring¦nullfalse
▹▹ namestringfalse
▹▹ stateenum(draft, commit)falseState of the scene.
▹▹ suppliedIdstring¦nullfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ treeEnabledbooleanfalseWhether or not scene trees can be viewed for this scene.
▹▹ worldOrientationOrientationfalseNormals describing up & front directions
▹▹▹ frontVector3true3D vector.
▹▹▹ upVector3true3D vector.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"a7e81c36-6799-42e9-afb5-d3e284c0dcf9","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"2f9824e4-3d89-4271-81fd-05bc4bbe4267","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a2bfa96f-907f-4960-b1c4-4600a4b0ac1e","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0472e664-4294-40c9-b4e5-4e51bdeaf0e9","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"406c24bf-9c2e-449e-99f0-06ab568122e5","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-scene"},{"name":"render Scene","id":"v-render-scene","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"image/jpeg"}],"url":"https://platform.vertexvis.com/scenes/:id/image?height=&width=","description":"

Get a rendered image of a scene. If only a single pixel is returned, ensure the scene is in the commit state and contains scene items.

\n","urlObject":{"path":["scenes",":id","image"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The height of the image to render.

\n","type":"text/plain"},"key":"height","value":""},{"description":{"content":"

The width of the image to render.

\n","type":"text/plain"},"key":"width","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"710cf451-2ef8-4c31-8aec-9c50ead7c750","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"image/jpeg"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"image/jpeg"}],"cookie":[],"responseTime":null,"body":""},{"id":"ab30d60e-9885-4bc5-b3b5-ccd0c0dd0cd8","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0df48ee3-810c-4ebe-bc76-05bac454404e","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"cf922293-4441-4364-b566-70185dc70614","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d0364592-dd11-4aa1-8645-143df382675e","name":"GatewayTimeout","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/image?height=&width=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","image"],"query":[{"description":"The height of the image to render.","key":"height","value":""},{"description":"The width of the image to render.","key":"width","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Gateway Timeout","code":504,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-render-scene"}],"id":"v-scenes","_postman_id":"v-scenes","description":""},{"name":"scene-view-states","item":[{"name":"delete Scene View State","id":"v-delete-scene-view-state","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-view-states/:id","description":"

Delete a scene-view-state.

\n","urlObject":{"path":["scene-view-states",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view-state ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"aded13f3-aa07-4d15-af7f-99c9c5fc13c0","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"2fdad71c-28d1-4346-a5cc-09325aff7adf","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"afaa07a6-47c2-4d06-bd38-7f2c31bccfa4","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"714952db-6b33-4fe6-9953-77af22bbaddf","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-scene-view-state"},{"name":"get Scene View State","id":"v-get-scene-view-state","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scene-view-states/:id?fields[scene-view-state]=","description":"

Get a scene-view-state by ID.

\n","urlObject":{"path":["scene-view-states",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. thumbnails is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[scene-view-state]","value":""}],"variable":[{"description":{"content":"

(Required) The scene-view-state ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0105aef6-1701-4b36-9646-e0760fbf6bd3","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id?fields[scene-view-state]=","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"canvas\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"canvas\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"da2e801f-699e-4e2d-bd9a-eee101b27dac","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id?fields[scene-view-state]=","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"99dbde20-600a-41e5-8052-29f75f00e94a","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id?fields[scene-view-state]=","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ce1a4383-f23e-4cd3-b504-01f78dc3931e","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id?fields[scene-view-state]=","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-view-state"},{"name":"update Scene View State","id":"v-update-scene-view-state","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scene-view-states/:id","description":"

Update a scene-view-state.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateSceneViewStateRequest_datatrue
▹ attributesUpdateSceneViewStateRequest_data_attributestrue
▹▹ namestringfalse
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scene-view-states",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene-view-state ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"029c5ab1-8b91-420e-a131-314c5086d895","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"canvas\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"canvas\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"251567d1-ab9c-4a2e-b022-0e4060f46e9e","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b2249db7-2436-4673-80d1-917889cfa5c7","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a5f5764e-cb67-4f9d-b80c-d13e3980b167","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"12ebc010-0a99-44af-83a6-fe8934a69c5a","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-view-states/:id","host":["https://platform.vertexvis.com"],"path":["scene-view-states",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view-state` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-scene-view-state"},{"name":"get Scene View States","id":"v-get-scene-view-states","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/scenes/:id/scene-view-states?page[cursor]=&page[size]=&fields[scene-view-state]=&filter[id]=&filter[suppliedId]=","description":"

Get scene-view-states for a scene.

\n","urlObject":{"path":["scenes",":id","scene-view-states"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. thumbnails is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[scene-view-state]","value":""},{"description":{"content":"

Comma-separated list of IDs to filter on.

\n","type":"text/plain"},"key":"filter[id]","value":""},{"description":{"content":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""}],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b2cf8d9e-3032-4a5c-89b9-ccb0506007fd","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states?page[cursor]=&page[size]=&fields[scene-view-state]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"canvas\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"canvas\"\n }\n }\n }\n },\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"canvas\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"canvas\"\n }\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9455772b-9583-4bba-afd5-0957c2049e4d","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states?page[cursor]=&page[size]=&fields[scene-view-state]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a63bc856-e748-4b00-af7e-db8ef832cca1","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states?page[cursor]=&page[size]=&fields[scene-view-state]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-scene-view-states"},{"name":"create Scene View State","id":"v-create-scene-view-state","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/scene-view-states","description":"

Create a scene-view-state for a scene.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSceneViewStateRequest_datatrue
▹ attributesCreateSceneViewStateRequest_data_attributestrue
▹▹ namestringfalse
▹▹ suppliedIdstringfalseID provided for correlation. For example, an existing ID from a PLM system.
▹▹ withCanvasWithCanvasfalse
▹▹▹ documentCanvasDocumenttrue
▹▹▹▹ items[oneOf]true
▹▹▹▹▹ anonymousLineItem2dfalse
▹▹▹▹▹▹ endPositionVector2true2D Vector.
▹▹▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹▹ endShapeanyfalse
▹▹▹▹▹▹▹ anonymousArrowEndShapefalse
▹▹▹▹▹▹▹▹ filledbooleantrueIndicates if the arrow end should be filled.
▹▹▹▹▹▹▹▹ typeenum(arrow-end)true
▹▹▹▹▹▹▹▹ widthnumbertrueA numerical floating-point value.
▹▹▹▹▹▹▹ anonymousCircleEndShapefalse
▹▹▹▹▹▹▹▹ diameternumbertrueA numerical floating-point value for the diameter of the end.
▹▹▹▹▹▹▹▹ filledbooleantrueIndicates if the circle end should be filled.
▹▹▹▹▹▹▹▹ typeenum(circle-end)true
▹▹▹▹▹▹▹ anonymousDashEndShapefalse
▹▹▹▹▹▹▹▹ typeenum(dash-end)true
▹▹▹▹▹▹▹▹ widthnumbertrueA numerical floating-point value indicating the width of the dash.
▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹ colorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹ ainteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹ startPositionVector2true2D Vector.
▹▹▹▹▹▹ startShapeanyfalse
▹▹▹▹▹▹▹ anonymousArrowEndShapefalse
▹▹▹▹▹▹▹ anonymousCircleEndShapefalse
▹▹▹▹▹▹▹ anonymousDashEndShapefalse
▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹ colorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹ thicknessnumbertrueA numerical floating-point value.
▹▹▹▹▹▹ typeenum(line-item-2d)true
▹▹▹▹▹ anonymousOvalItem2dfalse
▹▹▹▹▹▹ bottomRightVector2true2D Vector.
▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹ topLeftVector2true2D Vector.
▹▹▹▹▹▹ typeenum(oval-item-2d)true
▹▹▹▹▹ anonymousFreeformItem2dfalse
▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹ positions[Vector2]true[2D Vector.]
▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹ typeenum(freeform-item-2d)true
▹▹▹▹▹ anonymousCalloutItemfalse
▹▹▹▹▹▹ accentColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹ anchorPositionVector3true3D vector.
▹▹▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹▹▹ primaryColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹ textPositionVector2true2D Vector.
▹▹▹▹▹▹ typeenum(callout-item)true
▹▹▹▹▹ anonymousPinItem2dfalse
▹▹▹▹▹▹ accentColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹ positionVector3true3D vector.
▹▹▹▹▹▹ primaryColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹ typeenum(pin-item-2d)true
▹▹▹▹ typeenum(canvas-document-3d-v1, canvas-document-v1)true
▹▹▹ suppliedIdstringfalse
▹▹▹ typeenum(with-canvas)true
▹ relationshipsCreateSceneViewStateRequest_data_relationshipstrue
▹▹ sourceanytrue
▹▹▹ anonymousSceneViewRelationshipfalseRelationship to a scene-view.
▹▹▹▹ dataSceneViewRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(scene-view)trueResource object type.
▹▹▹ anonymousSceneViewStateRelationshipfalseRelationship to a scene-view-state.
▹▹▹▹ dataSceneViewStateRelationship_datatrue
▹▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹▹ typeenum(scene-view-state)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id","scene-view-states"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"db612f89-f104-49b1-b6ea-b5ae2ac1b88d","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"canvas\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"canvas\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"6a19d958-a9fa-4f75-871a-5387e11451ae","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3fcccacd-98b6-4231-9d79-82aae5fbad5e","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"03798a22-31ec-403a-ab53-c374c862b1c7","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e80c469b-431a-4e68-a25d-f00ec78f9fdc","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-view-state"}],"id":"v-scene-view-states","_postman_id":"v-scene-view-states","description":""},{"name":"search-sessions","item":[{"name":"create Search Session","id":"v-create-search-session","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"search-session\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/search-sessions","description":"

Create a search-session.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateSearchSessionRequest_datatrue
▹ attributesCreateSearchSessionRequest_data_attributestrue
▹▹ expiryinteger(int32)falseNumber of seconds before the search session is deleted.
▹ relationshipsCreateSearchSessionRequest_data_relationshipstrue
▹▹ sceneSceneRelationshipfalseRelationship to a scene.
▹▹▹ dataSceneRelationship_datatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(scene)trueResource object type.
▹ typeenum(search-session)trueResource object type.
\n
","urlObject":{"path":["search-sessions"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"9cfe0b1d-78f5-421f-9f3f-f9b54c519d4d","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"search-session\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/search-sessions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"29c54564-8087-4af5-a958-e5fadecafd7b","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"search-session\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/search-sessions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"847ec245-b7f6-4608-881d-03ef3e0c6dec","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"search-session\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/search-sessions"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-search-session"},{"name":"get Search Session","id":"v-get-search-session","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/search-sessions/:id","description":"

Get a search-session.

\n","urlObject":{"path":["search-sessions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The search-session ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"59c210a2-a6f9-42d1-ae9f-39f3a7ce36bd","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/search-sessions/:id","host":["https://platform.vertexvis.com"],"path":["search-sessions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `search-session` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1dedea8a-418f-4c88-9633-8addb88bab51","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/search-sessions/:id","host":["https://platform.vertexvis.com"],"path":["search-sessions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `search-session` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"bc0499a7-2961-46d2-9383-4b7a54c81258","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/search-sessions/:id","host":["https://platform.vertexvis.com"],"path":["search-sessions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `search-session` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7183413f-ae0e-4c8c-bf05-ccbb5ce5f53e","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/search-sessions/:id","host":["https://platform.vertexvis.com"],"path":["search-sessions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `search-session` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-search-session"}],"id":"v-search-sessions","_postman_id":"v-search-sessions","description":""},{"name":"stream-keys","item":[{"name":"create Scene Stream Key","id":"v-create-scene-stream-key","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\",\n \"withSearchSession\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id/stream-keys","description":"

Create a stream-key for a scene.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateStreamKeyRequest_datatrue
▹ attributesCreateStreamKeyRequest_data_attributestrue
▹▹ excludePrunedItemsbooleanfalseWhether to exclude non-visible items in the view.
▹▹ expiryinteger(int32)falseNumber of seconds before the stream-key expires.
▹▹ propertyKeyPolicyIdstring(uuid)falseAn optional ID specifying the property-key-policy to apply to JWTs generated from this stream-key.
▹▹ sceneViewStateIdstring(uuid)falseAn optional ID specifying the scene-view-state to initialize scene-views created using this stream-key to. Mutually exclusive with sceneViewStateSuppliedId.
▹▹ sceneViewStateSuppliedIdstringfalseAn optional supplied ID specifying the scene-view-state to initialize scene-views created using this stream-key to. Mutually exclusive with sceneViewStateId.
▹▹ withSearchSessionbooleanfalseOptionally enables or disables the creation of a search session for the view. The default creates a session for the scene-view
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["scenes",":id","stream-keys"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4246f540-61a5-4ea8-8004-3c6c740099b6","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\",\n \"withSearchSession\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/stream-keys","host":["https://platform.vertexvis.com"],"path":["scenes",":id","stream-keys"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiry\": \"\",\n \"excludePrunedItems\": \"\",\n \"key\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0ec55a5d-ff23-4774-be50-4b9029fce043","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\",\n \"withSearchSession\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/stream-keys","host":["https://platform.vertexvis.com"],"path":["scenes",":id","stream-keys"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"c9f8ba8c-d4c5-40fe-8f65-850647dee6fe","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\",\n \"withSearchSession\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/stream-keys","host":["https://platform.vertexvis.com"],"path":["scenes",":id","stream-keys"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0bb0ea71-85fd-4b33-ab54-fe156e27b8bc","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\",\n \"withSearchSession\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/stream-keys","host":["https://platform.vertexvis.com"],"path":["scenes",":id","stream-keys"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-scene-stream-key"},{"name":"get Stream Keys","id":"v-get-stream-keys","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/stream-keys?page[cursor]=&page[size]=&filter[key]=","description":"

Get stream-keys.

\n","urlObject":{"path":["stream-keys"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Stream key to filter on.

\n","type":"text/plain"},"key":"filter[key]","value":""}],"variable":[]}},"response":[{"id":"09960440-52d5-4c7f-bea5-1e0758056387","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys?page[cursor]=&page[size]=&filter[key]=","host":["https://platform.vertexvis.com"],"path":["stream-keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Stream key to filter on.","key":"filter[key]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiry\": \"\",\n \"excludePrunedItems\": \"\",\n \"key\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiry\": \"\",\n \"excludePrunedItems\": \"\",\n \"key\": \"\",\n \"propertyKeyPolicyId\": \"\",\n \"sceneViewStateId\": \"\",\n \"sceneViewStateSuppliedId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"370924b5-96b2-4b52-affa-67d97c3451f2","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys?page[cursor]=&page[size]=&filter[key]=","host":["https://platform.vertexvis.com"],"path":["stream-keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Stream key to filter on.","key":"filter[key]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"0cf28067-80bf-4727-a8b1-a446b2dbe136","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys?page[cursor]=&page[size]=&filter[key]=","host":["https://platform.vertexvis.com"],"path":["stream-keys"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Stream key to filter on.","key":"filter[key]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-stream-keys"},{"name":"delete Stream Key","id":"v-delete-stream-key","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/stream-keys/:id","description":"

Delete a stream-key.

\n","urlObject":{"path":["stream-keys",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The stream-key ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"bc0116a1-de6c-4cf0-8ca1-b06ef6fa111f","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys/:id","host":["https://platform.vertexvis.com"],"path":["stream-keys",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `stream-key` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"8433b1fc-6305-41d0-9bd5-2ecd7402b312","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys/:id","host":["https://platform.vertexvis.com"],"path":["stream-keys",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `stream-key` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"7c45d3a7-0a43-4577-8c5e-1357948f423e","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys/:id","host":["https://platform.vertexvis.com"],"path":["stream-keys",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `stream-key` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"89245a91-e370-477c-959a-8b670f29a53f","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/stream-keys/:id","host":["https://platform.vertexvis.com"],"path":["stream-keys",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `stream-key` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-stream-key"}],"id":"v-stream-keys","_postman_id":"v-stream-keys","description":""},{"name":"threads","item":[{"name":"create Thread","id":"v-create-thread","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"open\",\n \"type\": \"issue\",\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"thread\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/collaboration-contexts/:id/threads","description":"

Create a thread belonging to a collaboration-context.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateThreadRequest_datatrue
▹ attributesCreateThreadRequest_data_attributestrue
▹▹ groupstringfalse
▹▹ isDraftingbooleanfalse
▹▹ referenceanyfalse
▹▹▹ anonymousCreateSceneReferencefalseA reference to a scene to be created for a thread.
▹▹▹▹ positionVector3false3D vector.
▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹ znumbertruez-axis coordinate.
▹▹▹▹ sceneIdstring(uuid)trueID of the resource.
▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹ typeenum(scene-reference)true
▹▹▹▹ withSceneViewStateanyfalse
▹▹▹▹▹ anonymousWithSceneViewIdfalseA sceneViewId to be associated as a reference.
▹▹▹▹▹▹ sceneViewIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(scene-view-id)true
▹▹▹▹▹▹ withCanvasWithCanvasfalse
▹▹▹▹▹▹▹ documentCanvasDocumenttrue
▹▹▹▹▹▹▹▹ items[oneOf]true
▹▹▹▹▹▹▹▹▹ anonymousLineItem2dfalse
▹▹▹▹▹▹▹▹▹▹ endPositionVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹▹ xnumbertruex-axis coordinate.
▹▹▹▹▹▹▹▹▹▹▹ ynumbertruey-axis coordinate.
▹▹▹▹▹▹▹▹▹▹ endShapeanyfalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousArrowEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹▹ filledbooleantrueIndicates if the arrow end should be filled.
▹▹▹▹▹▹▹▹▹▹▹▹ typeenum(arrow-end)true
▹▹▹▹▹▹▹▹▹▹▹▹ widthnumbertrueA numerical floating-point value.
▹▹▹▹▹▹▹▹▹▹▹ anonymousCircleEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹▹ diameternumbertrueA numerical floating-point value for the diameter of the end.
▹▹▹▹▹▹▹▹▹▹▹▹ filledbooleantrueIndicates if the circle end should be filled.
▹▹▹▹▹▹▹▹▹▹▹▹ typeenum(circle-end)true
▹▹▹▹▹▹▹▹▹▹▹ anonymousDashEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹▹ typeenum(dash-end)true
▹▹▹▹▹▹▹▹▹▹▹▹ widthnumbertrueA numerical floating-point value indicating the width of the dash.
▹▹▹▹▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹▹▹▹▹ colorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹▹▹ ainteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹▹▹ binteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹▹▹ ginteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹▹▹ rinteger(int32)trueColor value from 0 to 255.
▹▹▹▹▹▹▹▹▹▹ startPositionVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ startShapeanyfalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousArrowEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousCircleEndShapefalse
▹▹▹▹▹▹▹▹▹▹▹ anonymousDashEndShapefalse
▹▹▹▹▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹▹▹▹▹ colorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹▹ thicknessnumbertrueA numerical floating-point value.
▹▹▹▹▹▹▹▹▹▹ typeenum(line-item-2d)true
▹▹▹▹▹▹▹▹▹ anonymousOvalItem2dfalse
▹▹▹▹▹▹▹▹▹▹ bottomRightVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹▹▹▹ topLeftVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ typeenum(oval-item-2d)true
▹▹▹▹▹▹▹▹▹ anonymousFreeformItem2dfalse
▹▹▹▹▹▹▹▹▹▹ fillFillStyletrue
▹▹▹▹▹▹▹▹▹▹ positions[Vector2]true[2D Vector.]
▹▹▹▹▹▹▹▹▹▹ strokeStrokeStyletrue
▹▹▹▹▹▹▹▹▹▹ typeenum(freeform-item-2d)true
▹▹▹▹▹▹▹▹▹ anonymousCalloutItemfalse
▹▹▹▹▹▹▹▹▹▹ accentColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ anchorPositionVector3true3D vector.
▹▹▹▹▹▹▹▹▹▹ primaryColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹▹▹▹▹ textPositionVector2true2D Vector.
▹▹▹▹▹▹▹▹▹▹ typeenum(callout-item)true
▹▹▹▹▹▹▹▹▹ anonymousPinItem2dfalse
▹▹▹▹▹▹▹▹▹▹ accentColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ positionVector3true3D vector.
▹▹▹▹▹▹▹▹▹▹ primaryColorRGBAtruea color with red, green, blue and alpha channels.
▹▹▹▹▹▹▹▹▹▹ sceneItemIdstring(uuid)falseID of the resource.
▹▹▹▹▹▹▹▹▹▹ typeenum(pin-item-2d)true
▹▹▹▹▹▹▹▹ typeenum(canvas-document-3d-v1, canvas-document-v1)true
▹▹▹▹▹▹▹ suppliedIdstringfalse
▹▹▹▹▹▹▹ typeenum(with-canvas)true
▹▹▹▹▹ anonymousWithSceneViewStateIdfalseA sceneViewStateId to be associated as a reference.
▹▹▹▹▹▹ sceneViewStateIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(scene-view-state-id)true
▹▹▹ anonymousCreateDocumentReferencefalseA reference to a document to be created for a thread or reply.
▹▹▹▹ documentAnnotationCreateDocumentAnnotationfalseDocument annotation used when creating a document reference.
▹▹▹▹▹ contentPdfMarkuptrueThe content of the document annotation.
▹▹▹▹▹▹ canvasCanvasDocument2dtrue
▹▹▹▹▹▹▹ items[oneOf]true
▹▹▹▹▹▹▹▹ anonymousLineItem2dfalse
▹▹▹▹▹▹▹▹ anonymousOvalItem2dfalse
▹▹▹▹▹▹▹▹ anonymousFreeformItem2dfalse
▹▹▹▹▹▹▹ typeenum(canvas-document-2d-v1)true
▹▹▹▹▹▹ pageNumberinteger(int32)true
▹▹▹▹▹▹ typeenum(pdf-markup)true
▹▹▹▹▹ typeenum(document-annotation)true
▹▹▹▹ documentIdstring(uuid)falseID of the resource.
▹▹▹▹ typeenum(document-reference)true
▹▹ statusThreadStatustrue
▹▹ titlestringfalse
▹▹ typeThreadTypetrue
▹▹ withBodyDocumentWithBodyDocumentfalse
▹▹▹ documentTextDocumenttrue
▹▹▹▹ rootRootNodetrue
▹▹▹▹▹ content[oneOf]trueList of nodes
▹▹▹▹▹▹ content[oneOf]trueList of paragraph nodes
▹▹▹▹▹▹▹ anonymousTextNodefalse
▹▹▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹▹▹ typeenum(text-node)true
▹▹▹▹▹▹▹ anonymousMentionNodefalse
▹▹▹▹▹▹▹▹ typeenum(mention-node)true
▹▹▹▹▹▹▹▹ userIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(paragraph-node)true
▹▹▹▹▹ typeenum(root-node)true
▹▹▹▹ typeenum(text-document-v1)true
▹▹▹ typeenum(with-body-document)true
▹ typeenum(thread)trueResource object type.
\n
","urlObject":{"path":["collaboration-contexts",":id","threads"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The collaboration-context ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"02785770-98c0-4d69-a761-c8c086b38b45","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"open\",\n \"type\": \"issue\",\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"thread\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/threads","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","threads"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"status\": \"resolved\",\n \"type\": \"issue\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"group\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n },\n \"replyCount\": \"\",\n \"title\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"collaborationContext\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"collaboration-context\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"thread\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7343970d-e960-4e72-8b6a-41b68a0124f5","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"open\",\n \"type\": \"issue\",\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"thread\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/threads","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","threads"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d90b4f4c-2d7b-4e2f-8370-307a13150e9d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"open\",\n \"type\": \"issue\",\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"thread\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/threads","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","threads"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"3a0374bd-cd1a-442d-a5fd-c33274670ade","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"open\",\n \"type\": \"issue\",\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"thread\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/collaboration-contexts/:id/threads","host":["https://platform.vertexvis.com"],"path":["collaboration-contexts",":id","threads"],"variable":[{"key":"id","value":"","description":"(Required) The `collaboration-context` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-thread"},{"name":"get Threads","id":"v-get-threads","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/threads?fields[thread]=&filter[collaborationContextId]=&filter[collaborationContextId]=&page[cursor]=&page[size]=&include=&filter[status]=open,resolved&filter[group]=,","description":"

Get a page of threads.

\n","urlObject":{"path":["threads"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[thread]","value":""},{"description":{"content":"

Collaboration contexts to filter on.

\n","type":"text/plain"},"key":"filter[collaborationContextId]","value":""},{"description":{"content":"

Collaboration contexts to filter on.

\n","type":"text/plain"},"key":"filter[collaborationContextId]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""},{"description":{"content":"

The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved.

\n","type":"text/plain"},"key":"filter[status]","value":"open,resolved"},{"description":{"content":"

The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456.

\n","type":"text/plain"},"key":"filter[group]","value":","}],"variable":[]}},"response":[{"id":"65e8674a-9108-4cdc-991a-a7d6e344a5b2","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads?fields[thread]=&filter[collaborationContextId]=&page[cursor]=&page[size]=&include=&filter[status]=open,resolved&filter[group]=,","host":["https://platform.vertexvis.com"],"path":["threads"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Collaboration contexts to filter on.","key":"filter[collaborationContextId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved.\n","key":"filter[status]","value":"open,resolved"},{"description":"The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456.\n","key":"filter[group]","value":","}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"status\": \"resolved\",\n \"type\": \"comment\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"group\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n },\n \"replyCount\": \"\",\n \"title\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"collaborationContext\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"collaboration-context\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"thread\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"status\": \"open\",\n \"type\": \"comment\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"group\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n },\n \"replyCount\": \"\",\n \"title\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"collaborationContext\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"collaboration-context\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"thread\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n }\n ]\n}"},{"id":"35b8e510-b2ee-4a60-996b-749b6f7ec607","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads?fields[thread]=&filter[collaborationContextId]=&page[cursor]=&page[size]=&include=&filter[status]=open,resolved&filter[group]=,","host":["https://platform.vertexvis.com"],"path":["threads"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Collaboration contexts to filter on.","key":"filter[collaborationContextId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved.\n","key":"filter[status]","value":"open,resolved"},{"description":"The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456.\n","key":"filter[group]","value":","}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5b776cb0-5fc8-4cfe-b081-03f6aad28a48","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads?fields[thread]=&filter[collaborationContextId]=&page[cursor]=&page[size]=&include=&filter[status]=open,resolved&filter[group]=,","host":["https://platform.vertexvis.com"],"path":["threads"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Collaboration contexts to filter on.","key":"filter[collaborationContextId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""},{"description":"The statuses of a thread to filter by. Send as a CSV list, e.g. open,resolved.\n","key":"filter[status]","value":"open,resolved"},{"description":"The group prefixes to filter threads by. Send as a CSV list, e.g. file:123,file:456.\n","key":"filter[group]","value":","}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-threads"},{"name":"delete Thread","id":"v-delete-thread","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/threads/:id","description":"

Remove a thread.

\n","urlObject":{"path":["threads",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"4255a44e-2c1c-4c58-9e50-c52d4919de93","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"f0394346-0349-4d35-9d13-d8452922c3ec","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"de265cec-1123-4a57-926a-8c8ebf2d2cca","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-thread"},{"name":"get Thread","id":"v-get-thread","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/threads/:id?fields[thread]=&include=","description":"

Get a thread.

\n","urlObject":{"path":["threads",":id"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.

\n","type":"text/plain"},"key":"fields[thread]","value":""},{"description":{"content":"

Comma-separated list of relationships to include in response.

\n","type":"text/plain"},"key":"include","value":""}],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"bdf5f2b3-53cf-4587-9477-043ac3ea6bb9","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id?fields[thread]=&include=","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"status\": \"resolved\",\n \"type\": \"issue\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"group\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n },\n \"replyCount\": \"\",\n \"title\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"collaborationContext\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"collaboration-context\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"thread\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8c21c0cd-b9bb-41f9-8346-c97e24745a8b","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id?fields[thread]=&include=","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"869d3a77-cef4-4062-b8c1-3a7cb97f069d","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id?fields[thread]=&include=","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"55cb8d0a-10cf-44f5-9d89-4536d9e0bd07","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id?fields[thread]=&include=","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. Due to its potential size, metadata is only returned if explicitly requested.","key":"fields[thread]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-thread"},{"name":"update Thread","id":"v-update-thread","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"status\": \"open\",\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/threads/:id","description":"

Update a thread.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateThreadRequest_datatrue
▹ attributesUpdateThreadRequest_data_attributestrue
▹▹ groupstring¦nullfalse
▹▹ isDraftingbooleanfalse
▹▹ statusThreadStatusfalse
▹▹ titlestring¦nullfalse
▹▹ withBodyDocumentWithBodyDocumentfalse
▹▹▹ documentTextDocumenttrue
▹▹▹▹ rootRootNodetrue
▹▹▹▹▹ content[oneOf]trueList of nodes
▹▹▹▹▹▹ content[oneOf]trueList of paragraph nodes
▹▹▹▹▹▹▹ anonymousTextNodefalse
▹▹▹▹▹▹▹▹ textstringtrue
▹▹▹▹▹▹▹▹ typeenum(text-node)true
▹▹▹▹▹▹▹ anonymousMentionNodefalse
▹▹▹▹▹▹▹▹ typeenum(mention-node)true
▹▹▹▹▹▹▹▹ userIdstring(uuid)trueID of the resource.
▹▹▹▹▹▹ typeenum(paragraph-node)true
▹▹▹▹▹ typeenum(root-node)true
▹▹▹▹ typeenum(text-document-v1)true
▹▹▹ typeenum(with-body-document)true
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["threads",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0b67568a-d8b3-4bf4-9fec-be699bc310b5","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"status\": \"open\",\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"status\": \"resolved\",\n \"type\": \"issue\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"group\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n },\n \"replyCount\": \"\",\n \"title\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"collaborationContext\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"collaboration-context\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"thread\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"438afa37-7b82-4db8-af01-651604a72a8f","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"status\": \"open\",\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ce81e1a9-ef43-4b0e-bdf7-df7035d0e2ae","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"status\": \"open\",\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"9897772e-4fdd-40eb-a1b4-b6131195f773","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"group\": \"\",\n \"isDrafting\": \"\",\n \"status\": \"open\",\n \"title\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id","host":["https://platform.vertexvis.com"],"path":["threads",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-thread"},{"name":"get Thread Participants","id":"v-get-thread-participants","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/threads/:id/users","description":"

Get a threads users.

\n","urlObject":{"path":["threads",":id","users"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"ddad74a3-1a52-48a8-b7e9-5686d4b39f53","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7d02ea68-f87c-472b-96d0-4d232c18679d","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5bf9840c-d47b-4cf3-952f-b0b975810330","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a7bcc4ea-621f-4dd5-8b2c-9b1da1d5cf10","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-thread-participants"}],"id":"v-threads","description":"

Requires Engage Module

\n","_postman_id":"v-threads"},{"name":"translation-inspections","item":[{"name":"post Query Translation Jobs","id":"v-post-query-translation-jobs","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs","description":"

Get all the specified translation jobs.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
filterQueryTranslationJobs_filtertrue
▹ jobId[string]true
\n
","urlObject":{"path":["query-translation-jobs"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"0a539145-407f-433b-88c8-972bdb16bdab","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"completed\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"geometrySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"completed\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"geometrySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ]\n}"},{"id":"b4bfe832-6cd8-4624-ac65-56416a9a1de1","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ca65544c-6e32-4c61-817e-4726282789df","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f8d7fdaa-7f42-4710-8e5c-e9311fb9214e","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"49724222-1bb4-44ee-897d-d6d341514e50","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-post-query-translation-jobs"},{"name":"get Queued Translation Jobs","id":"v-get-queued-translation-jobs","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-translation-jobs?page[cursor]=&page[size]=&sort=&filter[status]=&filter[completedAt]=7536","description":"

Get all current translation jobs in progress.

\n","urlObject":{"path":["queued-translation-jobs"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Status to filter on.

\n","type":"text/plain"},"key":"filter[status]","value":""},{"description":{"content":"

The completion date and time to filter on.

\n","type":"text/plain"},"key":"filter[completedAt]","value":"7536"}],"variable":[]}},"response":[{"id":"90deacd9-d340-48b4-8cc6-e41d9d5253fe","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs?page[cursor]=&page[size]=&sort=&filter[status]=&filter[completedAt]=7536","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"filter[completedAt]","value":"7536"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"513ef0e5-0b1d-4746-8297-e296a48d83f9","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs?page[cursor]=&page[size]=&sort=&filter[status]=&filter[completedAt]=7536","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"filter[completedAt]","value":"7536"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"ce4b2830-3ed2-4bf4-8642-9f3f738f2aea","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs?page[cursor]=&page[size]=&sort=&filter[status]=&filter[completedAt]=7536","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"filter[completedAt]","value":"7536"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f1a4158a-973a-4ed3-986d-f5efce4fd232","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs?page[cursor]=&page[size]=&sort=&filter[status]=&filter[completedAt]=7536","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"filter[completedAt]","value":"7536"}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-translation-jobs"},{"name":"get Queued Translation Job","id":"v-get-queued-translation-job","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-translation-jobs/:id","description":"

Get a queued-translation-job. The response is either the status if running or error or, upon completion, the part-revision that was created. Once created, create scenes via the createScene API. For details, see our Render static scenes guide.

\n","urlObject":{"path":["queued-translation-jobs",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-translation ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3b6e7e0b-ee04-4869-ae15-4c15e4a4f46a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs/:id","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"completed\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"geometrySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0f1704ba-52fa-4e04-a34e-ebfb346abf71","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs/:id","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"708c3911-caae-468f-aea1-2b9d0cafc9de","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs/:id","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"093999f0-5e6c-44d5-816e-95711d52ba89","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs/:id","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a6947d1a-01b5-4c74-8b41-538728d7d0fc","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs/:id","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-translation-job"},{"name":"get Queued Translations","id":"v-get-queued-translations","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","description":"

This has been deprecated and replaced by queued-translation-jobs - Get queued-translations.

\n","urlObject":{"path":["queued-translations"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""},{"description":{"content":"

Status to filter on.

\n","type":"text/plain"},"key":"filter[status]","value":""}],"variable":[]}},"response":[{"id":"a1870481-ba71-4190-8f38-166a66233f81","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","host":["https://platform.vertexvis.com"],"path":["queued-translations"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5476bd6d-ba22-4e0b-bfd9-837a57bf270f","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","host":["https://platform.vertexvis.com"],"path":["queued-translations"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"4d9333b6-472a-4156-91e3-2131a45d43ed","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","host":["https://platform.vertexvis.com"],"path":["queued-translations"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"52ee3f32-0250-45d2-81e0-78add8851d74","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","host":["https://platform.vertexvis.com"],"path":["queued-translations"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"f55739f0-40aa-4c91-839d-c4c253c27354","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","host":["https://platform.vertexvis.com"],"path":["queued-translations"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-translations"},{"name":"get Queued Translation","id":"v-get-queued-translation","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/queued-translations/:id","description":"

This has been deprecated and replaced by queued-translation-jobs/{id} - Get a queued-translation. The response is either the status if running or error or, upon completion, redirects to the created part-revision. Once created, create scenes via the createScene API. For details, see our Render static scenes guide.

\n","urlObject":{"path":["queued-translations",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The queued-translation ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"f5059686-63ef-4942-993d-a11050816714","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations/:id","host":["https://platform.vertexvis.com"],"path":["queued-translations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c22f3e24-20b0-4dcd-9ee1-ff660b46c6f2","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations/:id","host":["https://platform.vertexvis.com"],"path":["queued-translations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"4fcdf798-afc8-4b53-8fa5-884a417a7003","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations/:id","host":["https://platform.vertexvis.com"],"path":["queued-translations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2bdf549f-cb02-48ad-af24-88f387f56df1","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations/:id","host":["https://platform.vertexvis.com"],"path":["queued-translations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"39cb2a43-b57c-4581-9f06-3ece5e5ac092","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations/:id","host":["https://platform.vertexvis.com"],"path":["queued-translations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-queued-translation"},{"name":"create Translation Inspection","id":"v-create-translation-inspection","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/translation-inspections","description":"

Create a translation-inspection.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateTranslationInspectionRequest_datatrue
▹ relationshipsCreateGeometrySetRequest_data_relationshipstrue
▹▹ sourceFileRelationshiptrueRelationship to a file.
▹▹▹ dataFileRelationshipDatatrue
▹▹▹▹ idstring(uuid)trueID of the resource.
▹▹▹▹ typeenum(file)trueResource object type.
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["translation-inspections"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"549863ad-f114-46b9-8c04-1023feb64afa","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/translation-inspections"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"missing\": [\n \"\",\n \"\"\n ],\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1b9e2139-9156-4b6b-90cc-b31c99be0667","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/translation-inspections"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"49820072-dbcf-4dd7-926b-ab9a73ef06fe","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/translation-inspections"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a8b85b69-2622-4a8b-8df5-c3a979384a52","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/translation-inspections"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-translation-inspection"},{"name":"get Inspection Job","id":"v-get-inspection-job","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/translation-inspections/:id","description":"

Get a translation-inspection by ID.

\n","urlObject":{"path":["translation-inspections",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The translation-inspection ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e23b3605-b3da-45bf-94b1-7c1fa2d726b1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/translation-inspections/:id","host":["https://platform.vertexvis.com"],"path":["translation-inspections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `translation-inspection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"missing\": [\n \"\",\n \"\"\n ],\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"14c331cd-5637-407f-a8a2-2a807e649e50","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/translation-inspections/:id","host":["https://platform.vertexvis.com"],"path":["translation-inspections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `translation-inspection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"02f6ac06-00a0-47fd-83a1-5c0191cca3ea","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/translation-inspections/:id","host":["https://platform.vertexvis.com"],"path":["translation-inspections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `translation-inspection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"50fef326-cb3b-4abf-bf96-185d1a1cbe63","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/translation-inspections/:id","host":["https://platform.vertexvis.com"],"path":["translation-inspections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `translation-inspection` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-inspection-job"}],"id":"v-translation-inspections","_postman_id":"v-translation-inspections","description":""},{"name":"users","item":[{"name":"list Users","id":"v-list-users","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/users?filter[idpId]=&page[cursor]=&page[size]=","description":"

List users.

\n","urlObject":{"path":["users"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

Id from the idpProvider.

\n","type":"text/plain"},"key":"filter[idpId]","value":""},{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"199c83df-4ad5-4134-a728-21e804d650b0","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users?filter[idpId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users"],"query":[{"description":"Id from the idpProvider.","key":"filter[idpId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"74413456-49fc-40b7-bc87-990e957671cd","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users?filter[idpId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users"],"query":[{"description":"Id from the idpProvider.","key":"filter[idpId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"1496aebb-4752-4142-a64d-1b07251d538a","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users?filter[idpId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users"],"query":[{"description":"Id from the idpProvider.","key":"filter[idpId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"6a671415-9636-4e84-828d-002afd3914cf","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users?filter[idpId]=&page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users"],"query":[{"description":"Id from the idpProvider.","key":"filter[idpId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-list-users"},{"name":"create User","id":"v-create-user","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"type\": \"user\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/users","description":"

Create a user

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateUserRequest_datatrue
▹ attributesCreateUserRequest_data_attributestrue
▹▹ emailstringtrueEmail of the user
▹▹ fullNamestringtrueFull name of the user.
▹▹ idpIdstringfalse
▹ typeenum(user)trueResource object type.
\n
","urlObject":{"path":["users"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"3dc24a0c-91f2-43e3-a33d-4b8ab485b201","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"type\": \"user\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"bf567245-14a3-41d1-b6c9-76d878b44f47","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"type\": \"user\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/users"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2c812089-46f0-4877-a1aa-0c11f0caba00","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"type\": \"user\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/users"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d0336729-94f0-4b71-9c20-b37a66e278fc","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"type\": \"user\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/users"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-user"},{"name":"get User","id":"v-get-user","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/users/:id","description":"

Get a user.

\n","urlObject":{"path":["users",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The user ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"89cacad7-2543-4907-9b41-46703f3dac32","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id","host":["https://platform.vertexvis.com"],"path":["users",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"eac6ca94-d911-4329-928f-8a31af493071","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id","host":["https://platform.vertexvis.com"],"path":["users",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"49a5aaf4-8f2e-4530-87af-658f58169103","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id","host":["https://platform.vertexvis.com"],"path":["users",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"e261bfcc-0aa1-4388-89bd-afcf05d2e90e","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id","host":["https://platform.vertexvis.com"],"path":["users",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-user"},{"name":"get User Groups For User","id":"get-user-groups-for-user","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/users/:id/user-groups?page[cursor]=&page[size]=","description":"

Get user-groups.

\n","urlObject":{"path":["users",":id","user-groups"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[{"description":{"content":"

(Required) The user ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"49ba2e91-7c2d-4592-82b8-f321f33d39b5","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id/user-groups?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users",":id","user-groups"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5959710a-9434-4bc3-92db-1fe3c9d66881","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id/user-groups?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users",":id","user-groups"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"8fc82a80-3fc6-4c3e-9cfd-6894e42267b5","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id/user-groups?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users",":id","user-groups"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"abb5898e-64e7-47ae-8bec-b07ff6395347","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id/user-groups?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["users",":id","user-groups"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"get-user-groups-for-user"}],"id":"v-users","_postman_id":"v-users","description":""},{"name":"user-groups","item":[{"name":"create User Group","id":"v-create-user-group","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"user-group\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/user-groups","description":"

Create a user-group

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateUserGroupRequest_datatrue
▹ attributesCreateUserGroupRequest_data_attributestrue
▹▹ namestringtrueName of the user group.
▹▹ suppliedIdstringfalse
▹ typeenum(user-group)trueResource object type.
\n
","urlObject":{"path":["user-groups"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"56471f08-6a38-4053-bca8-301a338c7377","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"user-group\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/user-groups"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"345d5327-2cb1-4caf-9780-99ca594204d7","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"user-group\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/user-groups"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"92c9206b-fefa-41d6-b54d-3afd4f4dda1a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"user-group\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/user-groups"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"2bd16178-bc7d-4134-b41b-33b54ac29cb7","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"user-group\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/user-groups"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-user-group"},{"name":"get User Group","id":"v-get-user-group","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/user-groups/:id","description":"

Get a user-group.

\n","urlObject":{"path":["user-groups",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The user-group ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"3df56eff-66dc-47f9-bb82-9c82699df7ab","name":"No Content","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/user-groups/:id","host":["https://platform.vertexvis.com"],"path":["user-groups",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user-group` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"93657bb6-7d9a-414d-ab4e-392ed9f20951","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/user-groups/:id","host":["https://platform.vertexvis.com"],"path":["user-groups",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user-group` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"b3ca7626-89c7-4e08-9aca-ab2c6d30a631","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/user-groups/:id","host":["https://platform.vertexvis.com"],"path":["user-groups",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user-group` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"a2842dd1-1094-4e56-bc07-d1a7b9e5437c","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/user-groups/:id","host":["https://platform.vertexvis.com"],"path":["user-groups",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user-group` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-user-group"},{"name":"add Users To User Group","id":"add-users-to-user-group","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user\"\n },\n {\n \"id\": \"\",\n \"type\": \"user\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/user-groups/:id/users","description":"

Add a user to a user-group.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
data[UserId]true
▹ idstring(uuid)trueID of the resource.
▹ typeenum(user)trueResource object type.
\n
","urlObject":{"path":["user-groups",":id","users"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) A user-group ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"e5625d41-d1e4-40fa-a9d9-070ee92c3859","name":"No Content","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user\"\n },\n {\n \"id\": \"\",\n \"type\": \"user\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/user-groups/:id/users","host":["https://platform.vertexvis.com"],"path":["user-groups",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) A `user-group` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"ab042da3-c4d1-438c-9d4c-3cb71c38fc0d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user\"\n },\n {\n \"id\": \"\",\n \"type\": \"user\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/user-groups/:id/users","host":["https://platform.vertexvis.com"],"path":["user-groups",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) A `user-group` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"75e9f026-2a6d-4e21-8843-709c1cd353d0","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user\"\n },\n {\n \"id\": \"\",\n \"type\": \"user\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/user-groups/:id/users","host":["https://platform.vertexvis.com"],"path":["user-groups",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) A `user-group` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"4a0d090e-8068-4585-bec5-2de19907691d","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"id\": \"\",\n \"type\": \"user\"\n },\n {\n \"id\": \"\",\n \"type\": \"user\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/user-groups/:id/users","host":["https://platform.vertexvis.com"],"path":["user-groups",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) A `user-group` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"add-users-to-user-group"}],"id":"v-user-groups","_postman_id":"v-user-groups","description":""},{"name":"webhook-subscriptions","item":[{"name":"get Webhook Subscriptions","id":"v-get-webhook-subscriptions","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/webhook-subscriptions?page[cursor]=&page[size]=","description":"

Get webhook-subscriptions.

\n","urlObject":{"path":["webhook-subscriptions"],"host":["https://platform.vertexvis.com"],"query":[{"description":{"content":"

The cursor for the next page of items.

\n","type":"text/plain"},"key":"page[cursor]","value":""},{"description":{"content":"

The number of items to return.

\n","type":"text/plain"},"key":"page[size]","value":""}],"variable":[]}},"response":[{"id":"20c1da91-d9e0-4c03-8c02-d64c22f6295a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"57f37e11-3862-43c6-aad8-ca7137d43c25","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"201d30f9-5484-4777-aed2-fd50f54becc1","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-webhook-subscriptions"},{"name":"create Webhook Subscription","id":"v-create-webhook-subscription","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions","description":"

Create a webhook-subscription

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateWebhookSubscriptionRequest_datatrue
▹ attributesCreateWebhookSubscriptionRequest_data_attributestrue
▹▹ topics[NonEmptyString]true
▹▹ urlstringtrue
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["webhook-subscriptions"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"153a29a6-a89a-4822-a768-50c95e91ac4d","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f4d1a056-86a0-4447-8d62-5acf403d66f4","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"8593ecc2-0645-47b5-b10b-f0fe0e15da54","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-create-webhook-subscription"},{"name":"delete Webhook Subscription","id":"v-delete-webhook-subscription","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/webhook-subscriptions/:id","description":"

Delete a webhook-subscription.

\n","urlObject":{"path":["webhook-subscriptions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The webhook-subscription ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"9e64818e-1609-45e2-ac69-cac5ccde2d88","name":"No Content","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"2a7c1855-595d-4aa1-9a22-ac940db54c41","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"78c87a70-d078-40e4-97a9-795d5b022dd9","name":"Not Found","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"77c45ad2-fe86-420c-916a-7daa70ffb79a","name":"Unsupported Media Type","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-delete-webhook-subscription"},{"name":"get Webhook Subscription","id":"v-get-webhook-subscription","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"}],"url":"https://platform.vertexvis.com/webhook-subscriptions/:id","description":"

Get a webhook-subscription.

\n","urlObject":{"path":["webhook-subscriptions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The webhook-subscription ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"55d80f0c-078e-472a-aea8-b0e130b83655","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c22f7dcc-b978-41ea-ae20-a241e20e1239","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"aab26990-c836-42a1-bdc6-a06d7921535e","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"bf77c4e9-03dc-48ab-84af-b5db8c02c594","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-get-webhook-subscription"},{"name":"update Webhook Subscription","id":"v-update-webhook-subscription","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[],"advancedConfig":[{"key":"accessTokenUrl","value":""},{"key":"grant_type","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions/:id","description":"

Update a webhook-subscription.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateWebhookSubscriptionRequest_datatrue
▹ attributesUpdateWebhookSubscriptionRequest_data_attributestrue
▹▹ statusenum(active, paused)falseStatus of subscription.
▹▹ topics[NonEmptyString]false
▹▹ urlstringfalse
▹ typestringtrueResource object type.
\n
","urlObject":{"path":["webhook-subscriptions",":id"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[{"description":{"content":"

(Required) The webhook-subscription ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"1a188469-beaf-4bca-9f70-4a5f494a9860","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5731cab8-7585-4308-8af7-987448406642","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"71e0f3e0-7955-4a3c-8298-166417a7a836","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"d24e9497-afa6-40ce-941d-64d47be96ddb","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"},{"id":"5a7e8cac-f799-4a57-a494-ece5f0ee89b9","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n }\n}"}],"_postman_id":"v-update-webhook-subscription"}],"id":"v-webhook-subscriptions","_postman_id":"v-webhook-subscriptions","description":""}],"variable":[{"key":"baseUrl","value":"https://platform.vertexvis.com"}]}