{"info":{"_postman_id":"b719e6f8-8dea-4ca7-a220-a23e76612a86","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":"12234324","collectionId":"b719e6f8-8dea-4ca7-a220-a23e76612a86","publishedId":"T1LFoWUP","public":true,"customColor":{"top-bar":"F5F5F5","right-sidebar":"282A36","highlight":"FF8400"},"publishDate":"2024-05-21T15:55:12.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":"4fd7b8c5-efea-43b8-919e-d3c7af629b5e","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":"e5c472da-40c2-4cb2-bdc9-a127d8be0fb6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d460c8ee-2a2c-45f2-af18-d818a7d11691","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e6139d84-14bf-4b6c-b4d0-2d95b39d13d8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"99d6f78e-bbae-4923-b98c-20e0358df990","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":"4d877e5d-68e2-4b8f-ad91-409b52e4b137","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"74e0ddab-5086-4471-9c5f-b326bef6aca7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4562a011-257b-4129-a68f-1d7524125327","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"119886aa-b378-42ef-a23b-eb35d270ae12","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":"b841f5c9-b045-49ed-a77f-4c1b1063c4c1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b21d204d-ed33-445f-b095-66c6e01c9a3e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8a341980-d263-4ea2-99d7-883d759ed6fe","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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\": \"active\"\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":"0fb1f8a6-0c0e-4b88-97e3-e82a640165c0","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\": \"active\"\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":"e7658f56-7c88-48bb-b188-7522e2cd1875","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\": \"active\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ff752748-154d-4088-be8f-85ebcb30e0f8","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\": \"active\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"47717ea5-ee56-4544-b095-13febe9fffff","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\": \"active\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"14381329-5944-48e4-8e17-c2297fbef64b","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\": \"active\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"61ab4a0f-ad4e-4765-a846-48a7ad00b77f","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":"b3272a66-33de-4bbf-9f81-52cd8b63a65e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b718d245-ee7c-4622-ad7b-16d181d05222","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aac0a872-edc1-4baf-a6b9-dedece9f7599","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"27daa031-279f-4a82-80ab-cc80d1faec36","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"8b1afe4f-1fdc-4abb-880b-2e5f67b87cd9","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 }\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":"d8f6f6d5-3736-490f-9d5a-e3a9efdf5bb3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7c604030-e240-4147-a7c1-499a2f2abff9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 \"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/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\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":["applications"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"c14c0c5b-1969-4b33-9898-3b16e8c5f84c","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":"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":"67263ab4-592a-454d-bb4b-4d13fb2cd795","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":"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b132415d-6f6b-47f9-8f95-adfae09ccd67","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":"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cc354008-f9d4-428e-bba3-a685a5c301e7","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":"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"146f39fd-0b89-4c4d-ab50-5135f5dcc313","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":"323f554d-ed70-4326-8576-b62efbf91a81","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c2dc6293-0bbb-43d8-9fcc-f716b4095331","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"efa98175-67a9-4634-b001-618225674720","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"02692327-a5ad-4dcd-8385-0ddd1d0498a7","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 \"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 }\n}"},{"id":"1d3e3ad0-8a17-4ad3-a738-645df117104f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4b4ea3f2-22b2-4138-9d39-a759c189d0bb","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"df9e5ab8-02b7-46ff-acb9-1e1ce4d609a0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 \"scopes\": [\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\n\n\n\n\n\n
NameTypeRequiredDescription
dataUpdateApplicationRequest_datatrue
▹ attributesUpdateApplicationRequest_data_attributestrue
▹▹ namestringfalse
▹▹ redirect_uris[NonEmptyString]false
▹▹ scopes[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":"e22af8dd-f159-45cf-851a-c4e011568d5b","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 \"scopes\": [\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 \"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 }\n}"},{"id":"82537177-f8cb-45f6-876b-94de8799ab25","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 \"scopes\": [\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"21eadea3-5450-4020-997f-dd47327ed223","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 \"scopes\": [\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a9f3d3e9-3861-4376-9eb1-68fdca833e18","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 \"scopes\": [\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"72b5a7d0-e8e9-4597-9beb-83059a985218","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 \"scopes\": [\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f49daaf7-5785-494c-ad2d-f93b9341f34c","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\": true\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\": 1413.1273979532666\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e835bd87-fb92-43ce-9d91-107bd4457b77","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3d914314-87c6-4d6c-afd2-b156e9af27c5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"991cc0d6-396c-4966-9e13-621e8c13cd80","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"42875927-5274-4517-b313-a57490f55bf6","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\": 5111.4906805152095\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":"091c130e-7bbe-4729-ba28-3dcbd8b369cf","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2c52f1cc-2255-4357-abc7-8a55a7a090af","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"012ecd7f-f13e-4f14-b34d-3889aca531cc","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"0b77e546-4c57-4d41-af10-ee42a57c5588","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"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\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":"d0f433ae-eee4-4f5c-88d3-d67141f876e0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9b953b99-b509-4513-aa4b-b6f3c4cabd27","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5b195838-2199-4805-b221-c0fbdd16d5e5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"5db27d4a-000b-4964-a166-d77a16cb10f2","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"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\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":"ce0d78b8-003b-4909-b1d3-73f938008d87","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e1caa300-a908-4f4b-935b-e4638f771f78","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b2bd0225-ec17-487d-a3cf-eeec926acb37","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 },\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\": \"add\",\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":"740045cd-83cf-4c76-a8bf-f95873445db9","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 },\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\": \"add\",\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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"60bf6d92-0d32-4620-bbb7-59878e3a6e3b","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 },\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\": \"add\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1a9fc271-319d-4281-b4b2-5dc3975ee5c6","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 },\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\": \"add\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2121125e-6b02-4f21-82ec-facf3db639a5","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 },\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\": \"add\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"9506d7e7-9b73-4396-8430-209b528bdd60","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":"586efae0-ee78-4a61-b11f-7ee2ad61b8a8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1ef26313-cae9-4882-9f31-f3d1c2362372","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7dba0f76-a7b8-4599-88d0-148a39d84ad2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"0c07b01f-d53e-45bb-a41d-f731b3bc8696","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b3bfca1e-0416-432f-87c0-2d722eb58373","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":"6b3ddace-2381-4f20-8b5c-8a6964efc02d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f0abcfdc-f667-4743-a755-94c33e1328ee","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"81f43e18-290c-4411-ae50-dd24c984ebf8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d2cd7917-0121-4446-8f82-79813d554bf6","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 \"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":"58163e9c-29c7-4c16-a7a9-7579ca8a6574","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0dba3bb3-aae1-47c6-bf81-8ef94f433388","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fd6ad86c-1768-4039-8063-e02430d9c405","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"5b46dc23-72cf-4041-945d-f271a44c0cbe","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 \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"74de1532-5d5d-4902-85ec-5ee082d394a3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2adcc647-3594-4e5b-89b8-99fd3959d095","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"940454b5-5216-4418-ba1f-403f32bd653b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"a10d1f6c-3b9e-415e-883d-bb03d7e5d40e","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":"e07d01c1-7f31-4d80-83bf-289e9174a908","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4e55e0f1-742f-453a-8d57-b5d72001ad3c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"fc015d49-8636-46b9-a2b5-bdc0901220eb","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 \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c65e0ef9-bbb0-47e0-9250-33ca049422a6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"73e94518-bc14-4a09-af51-fd2be942f7c5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cdb1e69c-581a-43d7-945a-496577931b77","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"4959e234-7c85-4552-aa5a-fc47bb39caaf","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":"03d2087a-1afe-45c9-bbed-fd27d49546e8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a55cc310-e455-422b-a83c-69e5317e9254","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"120e36e1-8e56-45db-b277-02dcd2db2ac9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"69da6623-5830-4058-836a-2cd6c957c2b9","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 \"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":"ed77aa77-9acb-4565-9188-24710e93e9dc","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cf8713eb-cd98-433a-9019-ca1f969fe143","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d7368f4d-3dba-47fe-aca8-f767264af9c8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f4d1081e-4b64-4605-beb1-d816e5f74267","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":"52841bc5-0941-4324-a8e1-5117c2b7f0e3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a705d43f-bc4b-45d9-b7bb-3e008fc4ad24","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"15035d35-45fa-4cc4-979a-e7e8a5f79759","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 }\n}"},{"id":"06e5709c-1e74-4d95-bba8-73d9496dd557","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4b26577e-090c-4104-a962-0cd60170b388","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"06f2fad2-2ac1-4c25-861c-5959eaa10a2b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"65b4c76f-071d-4ffa-8b5e-92ce97f27447","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 }\n}"},{"id":"6c0c16b3-ef2a-45ee-a145-dee908b56ee6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5cb25bf0-8196-42d4-b9a4-eb099f5092f5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"56b7c329-c6af-4a16-ab98-10fe87e3e7e9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"7ea29cad-12b6-4fbb-8586-0c213690a7f5","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"67a0bddd-356e-4670-a568-9b2b5b18c72b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e7062e15-f73f-4756-b957-462e609511e8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"88c8906e-d91d-41a2-9db4-32074b6d103b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"36d204c2-11ab-4672-9747-520d49fef88a","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 }\n}"},{"id":"66907b9c-7d61-4fdd-a452-b20603d6b910","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bbd7d969-88c0-4357-a9c7-689056840810","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"adde9eef-2ea4-4b8f-aa43-6757a6439285","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"5f39d4fa-dd2a-4485-b41c-a266a0319015","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4ec2d79e-86ab-468a-97a1-6ed7c2e14eeb","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":"d8b71dfc-149e-4bf0-8bd3-eaf85bf559b9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0fa7fb08-c595-4212-bc0a-89839043aed5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ced20f34-3d2b-4c8d-a895-45b4371f4630","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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]=&filter[suppliedId]=","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":"

Filters by name. filter[name]=value and filter[name][eq]=value perform exact matches, while filter[name][contains]=value performs a partial substring match.

\n","type":"text/plain"},"key":"filter[name]","value":""},{"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":""}],"variable":[]}},"response":[{"id":"301069bd-01ef-4301-8c41-0a038bfa5c84","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]=&filter[suppliedId]=","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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","value":""},{"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":""}]}},"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 \"key_1\": \"\",\n \"key_2\": \"\"\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 }\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4da22bb1-1fe6-4ff7-bb17-23c1032f9917","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]=&filter[suppliedId]=","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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","value":""},{"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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ebf2081a-aa0a-4ac2-b2de-b1493472205f","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]=&filter[suppliedId]=","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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","value":""},{"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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 },\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":"a4393b2b-56d5-4a32-ab6b-380fc94c80f3","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"18850620-a735-4fc5-979c-60390aaf0843","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a1068bac-6726-4563-9c08-92ebfd4bef28","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7cbbf55a-8eae-4822-8a93-9a5cc97fc8c9","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"752c97c4-c201-483d-a667-b19262c2133d","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c32223b0-98f4-4d35-9473-5dd98acb54a2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f53f709d-3864-4447-a38c-5f7840323a0d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a363d485-a1e3-489f-bf06-36346961061f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ae5b13dd-eecd-4db0-9cf6-7278d8c01828","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e258b837-1632-4ca5-b783-a8e87c98cdb4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"79a06792-4496-49cf-ba65-976e2823921c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9f2397fd-48f2-4751-b593-e52eea3159b1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"75765d99-d674-4308-ba9e-d5771910dc74","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8d33aeb8-09af-49ca-8a5d-c42e181d8b6c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0ed34b25-3058-4e3a-8019-b3a985b72455","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"60dcb14b-7399-4343-a90b-ba69c9af9ac5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"39f87de4-236e-4142-a4cd-1102fc42da9b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"88bffe61-e80a-4d66-8a49-3d2b0f4053fc","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":"902115b5-2158-4d27-b79d-7966cc779faa","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b02cc12e-054f-43cc-aa29-75d41ae4f2a5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5229438c-d6bd-4a84-82c0-f36195dbe0d3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"dbebf9ce-362d-42ca-a707-1226aa14ed79","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d13ffa60-b0b3-4c8d-957d-3e25c502697b","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"198c4de1-c6b6-4f8b-9a40-4b51b635b9b6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"529ebe6d-85f4-4049-a49c-52050eb7b116","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"01fdddce-c6aa-43db-ad99-866842230121","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"3d4b8b90-e343-4962-ab76-18cf43e30d54","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 \"key_1\": \"\"\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 },\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":"ee9c7e9f-7c65-4667-9854-342b67cc8179","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"47f8397b-94f3-4a56-9ced-803a584a3b5b","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b18be0dd-d028-4c91-aacf-532f36508bb2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"54259050-4a8a-49d0-b354-2a0adcc51f33","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"281c4d3f-0f71-4399-b189-255876e731d2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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]=&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 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":"1be194c8-c9a6-4585-b2fa-79ec8943124e","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]=&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 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 \"key_1\": \"\"\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 },\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":"55db2347-63db-4683-ae8a-c3b10a518703","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]=&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 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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7ac9bf89-da02-41e4-9cd3-711d15b27472","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]=&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 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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"0a3cc85f-c29d-473f-b1d9-b3538c3f6794","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 \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\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":"c6fe1482-45c7-4272-92fc-5e2623188402","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"726849ce-eac8-498a-8f22-62c2e2c7764d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"4e5cd5a1-fec6-4434-b438-4d591b03d2e5","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":"7c350570-0045-4943-87ce-43c4307c66e5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6a2a3439-10e0-4570-bcda-89b42782e63b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"93fa1a2d-9fcc-4248-bc06-b912638db4bc","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 \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\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":"10791c69-e199-4c33-b21c-a3bfd73baaad","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bc9d845a-126f-4e2f-b9d8-72d062c39275","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 \"key_1\": \"\",\n \"key_2\": \"\"\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":"e15c7cc6-773b-412d-8d51-8fc7b4478fde","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 \"key_1\": \"\",\n \"key_2\": \"\"\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 \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\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":"0b323d0e-4bb4-4679-a2b0-8d39f776a189","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 \"key_1\": \"\",\n \"key_2\": \"\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"74bed9b7-6d4c-4d3f-ac82-25a36de827a5","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 \"key_1\": \"\",\n \"key_2\": \"\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a8c6541c-2fe3-4475-adef-85569ea04350","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 \"key_1\": \"\",\n \"key_2\": \"\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"1105d598-5532-4adf-903d-339bb9ea3078","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":"2a9d9e5b-c6db-427f-b1c1-3bb4a5a3e562","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"19760ab7-0216-42af-bedc-5eec56fd0138","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"35021b1d-2b97-4286-a0c9-eef155a995e5","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 \"key_1\": \"\",\n \"key_2\": \"\"\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 }\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"cc4db64e-1420-4920-873e-1a2ea012a0ee","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4695545a-34d8-4b25-848b-6414af1e5590","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"6a2aa23d-aa6c-4360-bfe0-1a01716f103f","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 \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\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":"940a50a3-3c2b-47e1-a673-6a377a93f7f2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0eb5088b-7aeb-4295-9fff-6ce88dcae044","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"655944cf-acda-40db-9cb7-d057c4e1e413","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"743edc76-cbe0-475c-a146-c42aae96fee9","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 \"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"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"137b140b-ad8a-4a06-9453-0cc25bcdb5a5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c5a91cb0-7350-4a17-88d1-4f330a30a36b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b89c3555-2fe7-4183-aff1-8a9dde42e77f","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"285212bf-ae7e-4551-95f1-9e024466572e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bd9aaea1-a83b-4fe8-8030-1334ae727b0f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5e53039f-d5a8-4f76-8da0-3426bd5f1090","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"040bf6b2-98a7-40af-bdee-ab8c81cbcd7c","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 \"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 }\n}"},{"id":"b6193f29-ee97-444c-abe8-7db8ba6e00c2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"279a84da-f6d1-4fc5-97c8-ba6147276703","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"74a3c317-511b-48a7-a8bf-0b632ea0c161","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e4a2b4c7-190b-4efe-b9b5-d49c38a6e584","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"439c729e-c44c-482f-8421-e5ad994f4414","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4c216cb7-be37-41ed-8246-040ccbd12a04","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"c479ebf8-0feb-4eac-805b-250bebbc5a1b","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"548bb019-1df0-463e-a365-7423be2a3f23","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"847a0d8b-62ca-4c70-84d3-a7e430e199bb","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"73d837aa-2041-4279-803f-fa2d9577e01f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ba68f08e-a54f-4c64-8d1e-ef0a539d3b01","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 }\n}"},{"id":"70fc4042-793e-4495-a249-2e88aa6df8e4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e970ac32-59a8-411b-9cd8-c3c49b9c7197","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2de9e0b8-6036-4dcd-8226-a33c186673a9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5f7756f0-00c8-4f66-af8f-6d37536c622d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"5f658283-0532-4c4b-876b-8caacd95ebae","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 }\n}"},{"id":"e0841590-9eb4-4c17-bcc6-97eacfc88dc8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"14257dd5-60ee-4fa2-af1b-d941d8752c76","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6122fd7f-b496-4502-b09b-f0a70e384f93","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8c669a8d-f56b-484e-ae51-1d32ffe59482","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"237ad7c0-7d14-4942-b981-b38f9d9c9795","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fa9c5399-86ff-49aa-b99e-03a82ad73b88","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8c04a697-d0b3-4dc8-adb5-0bdd3aa00e1c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"87e04440-d036-466d-ac84-f2059d85b784","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b30f5d49-8d7a-4505-805d-47f9760d6ec7","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 }\n}"},{"id":"03c51a2a-3546-424c-a3a0-29332772faeb","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2cad1eac-e8e1-4ada-a869-e2b37fb76b27","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f67bdf7d-e1f9-45d8-8d34-e1fa37de3db7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"3a171952-ca6d-424a-a1f7-77b3320dd945","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 }\n}"},{"id":"1b793f5e-ae12-4218-aecb-aec1f36e553c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e005e0b0-c838-45b9-ac76-578ac84c1e11","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4c449031-2856-48a5-964e-e1a275428d0f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"534030f4-589a-4686-8704-8146f6242c74","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":"bd4f531b-0717-4786-b126-b35efb2226e3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ab58664a-c774-402e-9882-646baa32c7f7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"e3cd8d1d-c23a-4d4b-afbb-3a4adc200c09","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":"9819e83b-731e-468b-a652-c5cc95645a8a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6caa7bf7-8edc-43e3-921b-58a203aaa362","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"43a1423c-572a-4a20-8b53-feea4de3df88","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":"30c533b1-06a3-4b9a-a216-5d7a34a2a2ae","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":"8f020797-8e0d-4922-aee6-9e1160fb96f1","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":"c91b71d3-ba95-4a34-95f5-bab48d6f9c80","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 \"key_1\": {\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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"36cb4779-c731-45dd-888a-2d4683043220","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"32949b7f-fb0c-45ff-b9ea-f9435af2289d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d36a897c-3561-44c3-a962-2e51bd502f01","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8cee8d6c-0bbe-4cd4-8137-52bb634e49d0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"778ff2b5-df70-4f6a-8f2d-d7c2ad4c500e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6859fb44-3539-4eed-895b-927753d40a48","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d712b586-dfda-4be9-bc7a-3d8196b5a7b6","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9d12b696-b642-414f-8323-398520bfb97e","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ab5d35c1-9b95-4a8a-895c-84fcd240ac6f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f9b52821-b730-4b70-b74b-086f40e73d2c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b5d60dbd-6426-4e53-9643-ecd4d037c377","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5ab93b27-5473-45c6-ad05-9478415fda51","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"2f9a4a2d-7cf6-4292-9dd1-b345222f4b4b","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"be57b1b1-6f92-4dde-9c78-402207d22812","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e68018d2-90e3-4bf2-9903-8f966280708f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1051a354-058e-4d5e-b206-5cf2301989a8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d23782ad-93dd-41ae-a410-ce711f5e624d","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 },\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 }\n}"},{"id":"11a99071-9b3b-4636-960f-b2277484456f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1f4de783-78b3-41cb-b81e-f2c3633ccc0a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"df7e092f-e1dc-43ba-8b2d-3af6385b3943","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 \"key_2\": {\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":"65228ed9-9e4f-4d11-938b-660f44cd56af","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 \"key_2\": {\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 },\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 }\n}"},{"id":"0776c525-8fc1-47d6-a3a7-30adde9cb822","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 \"key_2\": {\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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"75f8d89a-0edf-4664-987c-6817e9aa1734","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 \"key_2\": {\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f76d2d10-ec73-4d55-af9d-53766788529e","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 \"key_2\": {\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1d9377a3-0cd9-4bf8-b748-7f0dfc6bc968","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 \"key_2\": {\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6b823dd4-3e6b-4d4f-8921-1679a70367f0","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 \"key_2\": {\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"4c55abc7-7b2a-4659-ac2d-89d4efda6957","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":"08d8919c-d428-46e0-a9d1-3c256afd547c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9585a8dd-3efb-4d69-93bf-dfe6bf68f310","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5aceddf5-fda4-430f-b474-3aa46071f7c0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"76ab22a3-55fa-4b0a-9a25-074bc16ca40c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"0362cabb-256f-473d-b923-3f8a4a2a9f44","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 },\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 },\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 }\n}"},{"id":"58fad7b8-7751-48af-8fdb-15f99a5c0ed5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5be7df33-f9a0-41f1-8270-a7eaa0a47d34","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d043a969-8257-4047-8157-8ba5668ec6c2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"33df7221-668e-4613-a9f8-02c9d6197148","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"dff9ad70-e1ca-4adc-ab75-6c318c62620c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1c753284-57d8-40cc-8483-32c48973c4a7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a9ca3646-d730-4dfc-90aa-59959cd764d3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"}],"_postman_id":"get-queued-part-revision-deletion"}],"id":"v-part-revisions","_postman_id":"v-part-revisions","description":""},{"name":"part-revision-topology-exports","item":[],"id":"v-part-revision-topology-exports","_postman_id":"v-part-revision-topology-exports","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":"a4369899-9f30-4d80-9307-6b207a5e7c4c","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 }\n}"},{"id":"61a0dd04-fb4d-4193-b9b5-8adf6fe9fe65","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"224fb614-fe07-4424-83d1-c9f7f2798ed3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"dae91b9a-e48f-4b1d-813b-1b23106f06e4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"264a56e2-b0b7-47a7-bcf8-8922fd1eb214","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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[name]=&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":"

Filters by name. filter[name]=value and filter[name][eq]=value perform exact matches, while filter[name][contains]=value performs a partial substring match.

\n","type":"text/plain"},"key":"filter[name]","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":"caec169b-7fdf-4d40-8774-57d6f9c02094","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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 \"key_1\": {\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 }\n}"},{"id":"57b15ad5-a22d-4181-a635-8af8d9efc639","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9e92db92-033d-4437-b0b5-74d6d2c3b8e8","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"4f8bb178-a425-4d3a-95ed-7dfc16fb5f70","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 },\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 }\n}"},{"id":"7ace30c5-02fc-46b2-8477-2c41a52184bf","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"00a37503-c057-43a1-9215-9d4c67a60084","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"080e929a-70ef-459d-a7d5-1abb08db6a88","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cfa8107a-4785-4bd6-8aea-d95fd698b31c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f1b1e7f2-2145-4fe8-8d14-e4758aee7625","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ef53c549-bba5-47fd-bffc-ee2a5c8c78e5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e70f42b8-f1be-428e-998b-61f2fbde383d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d3304ef7-7e94-45a7-b833-5c1cd8e0f703","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ccc7133f-70e7-462e-bc90-68400444a23c","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 },\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 }\n}"},{"id":"7274af9e-7ea4-40a8-835b-d900ec9ffcd7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5c2d70b9-beab-4a7f-ad09-557d7a246cb0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1aef5141-bd9d-4066-b118-f55e43d6c9b5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"6010b75a-85d5-4e94-bb06-d5235ff6d20c","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":"c59e9d70-91b4-427e-a923-871ff8fa2ce9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9aa55550-4f9a-4a12-9b40-d33c5ff68666","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"24f471cb-1d40-4a32-b6c0-d8e53fb3e768","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"08326e96-6922-401f-b1ec-23beb63da4da","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f6ab6cfe-db12-45e7-9679-652bfdff3d26","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ae08faed-eb39-4a65-8259-38a45b3a7895","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7ef97716-dc05-4519-87b4-b000ab3bddec","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"1b9b8d69-8f79-45e2-b846-37138ee1f9da","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 \"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 {\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 }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"72f2d86e-e9a5-40da-a656-d9d2ec014645","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"6f186e6a-276a-4abf-a79f-88959e76c008","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 \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b99c061d-0377-4761-91c1-b230a6b9463e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d6bc211a-69a6-448e-8d97-b05e7ef47bb4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0f8ac374-c45b-4b4b-aeea-4e2c58d04d05","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"c39573c3-4f87-4ee8-a660-9ae1dc449beb","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"85ed0497-55fc-48d7-ba44-c362801f0879","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8d2c45a0-d918-40eb-a533-9606b95791ac","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"90341d37-7c97-4f85-ba0e-5e3e7186bf2c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"0200d078-9a50-4426-87fe-1ab59b2e2284","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 }\n}"},{"id":"552bab96-6a35-45b1-ab1a-d0f36060506f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f918bf44-3eb3-474a-9fff-b1524f9c7a21","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 }\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":"2652a52e-8d15-4d2b-9f54-436468b818f9","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 }\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":"a5939a33-f372-4cf4-99c9-b110780cc623","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 }\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ce261251-053a-4172-bd61-dcb67abb01cc","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 }\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"58313ab0-d1d1-457d-98b6-59a9a77cb246","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 }\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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]=","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":""}],"variable":[]}},"response":[{"id":"9b417d8e-4919-4b52-8168-6b3effa1118e","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]=","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":""}]}},"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 \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"93ef83b9-bc96-4dae-abb6-44be18d66cae","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]=","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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"839e7d67-d420-4311-9510-2d4cf94fb9d2","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]=","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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"37975efd-0c6d-470e-95ea-480751a3ad35","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c2690381-9b5a-4bf2-9201-12f3e83f9444","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"da72ccd6-6246-4b72-8bda-e35042af0111","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"917bf48c-7f06-4a27-a4e2-3d2b4150d265","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"34a49930-5f96-4f7a-ad1b-b97f14fae236","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d954a4fc-80a6-49f9-b68a-8eec34084405","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":"4872fd1d-1db1-4e64-b94f-618105eb07d1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ad124d3a-01c9-4a92-8ee7-dc71d66d6e2a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f574a2a3-5ede-4ca0-a038-acdf447788be","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"197eed33-4554-48ca-b210-ea96803f3651","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"12284d2f-07a9-4512-a551-218917889073","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"52a31068-01a5-48ad-b013-544bb5a17d66","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ee67bad2-37e4-4e6b-9dbf-951a52ca5534","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"3a737c52-ae54-477e-bdd8-e82544ea65dc","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":"5c918a83-1178-4384-a0b7-feee1eca782f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7f130e1d-f5cc-4b7f-afe9-b922436357d6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d809398e-6236-4942-bca6-82bf9490c0af","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"87a16284-b5d8-4f78-9fe2-95594d28dbc3","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 \"key_1\": {\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 \"key_3\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c88cfd9d-38dd-45a4-861f-7369c92ccf1f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8a87c2fa-f1e2-4534-82f0-787e86d0261d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d6a604d2-f7f1-4107-b3a4-b9afcbefad3d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fb5a6cb4-9089-47bf-bb14-1da38d9a85d1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b00a7bbb-4d69-4088-a509-ad6648afaeaf","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":"4ad0b592-6174-432b-beef-fe4a258fa470","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"851a940e-8d6a-4ab8-8b27-fad90c315f40","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b75cfdc8-8a57-4660-88d2-a1370ccc2965","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b5372e16-4623-4f69-a638-2c805af79ffc","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f5a78d0a-a479-4ee7-8874-e103a30fc80c","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 }\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 \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\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 }\n }\n ]\n}"},{"id":"d41232c0-7ba9-4e04-9215-1bea36126391","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f628e1c1-8502-44e8-a965-914be516fd7d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c6e3b7ae-dccc-4695-9f91-0511a08212dd","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"666b0bb2-4edd-4530-9df3-a307b6846c28","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":"c146af16-5d92-4b08-bfc7-d93ac754a0be","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"30b0e767-dfd0-4b75-b72c-873549c3d496","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"73b10a0d-849d-40b7-a759-ec5e790c3fa8","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"key_3\": {\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n },\n \"key_4\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"dcfe2d4c-6361-47eb-b219-22245d5ab358","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"586fde9b-2746-431f-b444-fa1faffe89eb","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ec00cf08-09a1-4af6-b19d-5c9432d8c3b4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"387df50b-5b13-425b-8063-20007cbe409b","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"key_3\": {\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n },\n \"key_4\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"2b3d4990-1c3e-44d9-9f14-783ff8319dd3","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b2254d53-691b-4c5d-8919-b8f8ac4a716f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d7643e2b-93f6-4cd5-8718-0b27f0d6d6f9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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-3d-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":"694938cb-a05e-4b40-800e-800e584d76f0","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-3d-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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"key_3\": {\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n },\n \"key_4\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"dd8001e6-2fa6-4a03-b7b1-2084df3c5f93","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1a63968e-c6f1-49e7-8c74-c9301c2f07d8","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3efedf4d-5821-46a1-ad96-e6f505508b13","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"eb3f6592-c9f9-44a0-8ebe-8139abe263a2","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"35fa4532-ff03-4831-bfaf-802dc1b5b2a8","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":"bb11c8e2-2c77-451a-824a-d7aabbd59f56","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8a3f6d55-dc7d-4381-bf1b-a8e7edfd56ee","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"29ad0ace-9a44-4531-ad2b-1f73dfbbab6e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"8f8f1d27-a60d-4e7b-890b-2ce67d7e1c15","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1630699a-dc66-40e1-bb3a-54c561d9a5a4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a5b8cbaa-379f-4624-a6cf-b64cabcb6fd0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fcb70e1e-417b-4903-b3a1-1a1805b56ec6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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?page[cursor]=&page[size]=","description":"

Get scene-alterations for a scene-view.

\n","urlObject":{"path":["scene-views",":id","scene-alterations"],"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":"745660f9-f82e-4c3c-9aae-1dcab6389fdc","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"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 },\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 }\n}"},{"id":"6a422359-7ae7-4ba3-b457-d755e86cd1ad","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c3702870-45fe-4e49-aa2a-a9d78c6b6cf8","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"68d95188-f0f5-454a-832f-b6a57ad9d27a","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"c646f26f-38bd-4ba9-8cbb-57a3503d1679","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d446975a-89f5-45de-bf89-97105709a92a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"94c4e145-2b6a-4dcd-8206-b216fa4b54ab","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e4b58e7c-f6a3-42d0-8487-4512442963c9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6c2e8875-620f-426f-a897-c4a5c63f1468","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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\": \"#CEcd4C\",\n \"icon\": \"\",\n \"primaryColor\": \"#BeC526\"\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":"d4a98daf-ed64-467d-80ab-1a2b03b6f195","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\": \"#CEcd4C\",\n \"icon\": \"\",\n \"primaryColor\": \"#BeC526\"\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\": \"#d317cc\",\n \"icon\": \"\",\n \"primaryColor\": \"#9AD4EA\"\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"12b39b03-7af2-4b02-8226-833b2b7d350c","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\": \"#CEcd4C\",\n \"icon\": \"\",\n \"primaryColor\": \"#BeC526\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"6f858e81-5450-4528-8d12-281f7e727eaf","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":"611e5968-7750-4baa-bf72-03b7792567d1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"251edef3-89ea-42d7-a9a6-6b5b058adc37","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"13e3033c-5a31-4e06-9c0c-2b11bdfa787c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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\": \"#1FBf5b\",\n \"icon\": \"\",\n \"primaryColor\": \"#C885a9\"\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":"74651d15-bbfe-4836-baaf-c7f0192aae9e","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\": \"#1FBf5b\",\n \"icon\": \"\",\n \"primaryColor\": \"#C885a9\"\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\": \"#d317cc\",\n \"icon\": \"\",\n \"primaryColor\": \"#9AD4EA\"\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e48b2665-59cb-4bc2-989d-2727c3a1a801","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\": \"#1FBf5b\",\n \"icon\": \"\",\n \"primaryColor\": \"#C885a9\"\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"df5a6c3c-ed73-4366-94d8-b3a287cc7e72","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 \"key_1\": {\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 \"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 }\n}"},{"id":"d7086685-325f-4e26-b652-20d0cbe38ce7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"19fe7aca-c570-47c9-a2ad-58cfe60148e4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b30ac026-3ff1-4989-b916-57344a45c118","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"74313157-01c8-4c78-b174-1f34e2d87fb6","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 \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1f39528e-161d-4d60-9147-3a83c90324f0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ce4caae6-de17-489f-a31d-1fbe39a3b220","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":"5749b127-ef60-443f-b079-c8675206a386","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a19437db-15b3-4d8f-b76b-a75bc0733a97","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c3b69311-9e65-42a2-bd5a-b521ce552f66","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ac751be4-cc9f-4034-a8b5-92f8a2de0db9","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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"46fd2679-fbc4-4f2c-85a2-ac33c3250e57","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ffc93082-29d7-4e7a-9ffc-09b4efd41104","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a5f6d280-923c-49ff-b8dc-365e70e8e102","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"03ef4142-27e7-413e-b626-7197f7db32d0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"1a39853b-4a66-4f6d-b20b-71e4d32f047c","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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"35f8fd00-314b-4d6b-8a07-f50d41785821","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5f86be68-5d75-4a3f-9cb5-3878df597595","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aad631c3-3122-4db4-bddd-81e0aa6bd53d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"538b2962-c180-40d4-b2a0-c6b62ab46035","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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"97617f3c-9e6f-4809-ab27-82979a410028","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1c0b24ec-008c-4852-9671-64549c42f186","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"57ef6ca3-ae68-4849-a084-ac7b6ad5a7bf","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a9f45538-8070-4ad8-9a54-cad231b89cb0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f9118751-76fc-4431-b2fe-5e3e0e4a4340","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c7a4d24e-b4ea-4889-894a-dfb02bab4afd","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"74a1e674-5e0f-44ad-a372-ec89c8b38c48","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d0a75f59-32e8-4367-ba9f-a0d987f91389","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"95f92456-9afb-4028-8699-d5afdb60257a","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ec5cc598-024a-422f-9cd8-44a4fdcc08c5","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":"c88cdd98-3364-4940-a95b-1187614eeae0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f7cb61c2-f13c-4540-be9a-f48e998a2472","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1c5b07ff-1e09-4a99-ba12-574416c0626e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"71c6e0c8-ce63-4423-8065-c979aa5878b2","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":"c649107e-5cea-4fb0-99a6-f5ac2d9443af","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5742a281-1f8e-4f86-b3d2-7053c2266973","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5d26a767-78fb-4b5f-8809-a72bfb7f622f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"01c704c1-6069-4135-95a1-6bbfa535af7c","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 \"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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"08b12761-3d02-42f2-9452-fff7369ef46a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"174d1960-302b-41fe-946a-ce438588de38","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1069f28e-58a9-4c77-bc71-1f9387b0694e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 \"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 },\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":"db67b1db-2374-4ae2-9d35-6feee81ce6b3","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 \"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 },\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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"22434e70-9d56-4aa2-8e50-8f1a3e7280d4","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 \"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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b8f9b8cb-0646-459c-aa2a-e8e156005e45","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 \"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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4d213438-46a7-4944-a988-66cd7e0010cd","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 \"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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b9defc58-314b-43d2-87f7-2cdc7317d81c","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 \"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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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[name]=&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":"

Filters by name. filter[name]=value and filter[name][eq]=value perform exact matches, while filter[name][contains]=value performs a partial substring match.

\n","type":"text/plain"},"key":"filter[name]","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":"60ce8a31-7abd-4de5-b206-e64f7dd697e4","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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":"93310ee1-db52-4f3d-8b20-04d23f00f568","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c1d1bbfc-98f5-4210-b302-aab97ebe1d25","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"eb20feca-9b53-448e-98f2-4878d618e75c","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[name]=&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":"Filters by name. `filter[name]=value` and `filter[name][eq]=value` perform exact matches, while `filter[name][contains]=value` performs a partial substring match.","key":"filter[name]","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 \"key_1\": {\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}","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":"49b0b3d3-d675-4841-be6d-b6f051184d91","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 \"key_1\": {\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}","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f872af28-4652-4347-a33f-846fedef1913","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 \"key_1\": {\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}","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"076e380d-5ae9-48ff-a7d6-006471df09b2","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 \"key_1\": {\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}","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8271f6dd-613e-4ffd-b064-209ef217a16a","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 \"key_1\": {\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}","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"76e85a82-92f8-43f2-8fcc-717903db9934","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 \"key_1\": {\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}","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"49857e83-5411-4883-91fc-a7c07e734816","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 \"key_1\": {\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}","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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. The response is either the status if running or error or, upon completion, redirects to the created scene-sync.

\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":"19f9f375-bc8f-4c2d-a082-b0461b836d04","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b304de81-83f6-4111-bdc3-48446812a793","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-syncs/:id","host":["https://platform.vertexvis.com"],"path":["queued-scene-syncs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-scene-sync` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"ab872a60-5240-4b6c-8ef6-8ae1ef8da7f5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ab7405a8-4cf0-49e0-bda1-14b4c4b656b4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4f6f9ba4-9b01-4054-9449-eb1b79495816","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"74db2914-bdb7-4ed7-8f23-c7e3db65a93e","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 \"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 \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"4703b4e1-60f4-4fb3-806f-cd69885db0a2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"90b7cc4e-4372-47c3-bf1d-acbf88ef4003","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"87e84a55-1585-411e-ad02-9f07fea107be","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"60638464-a42e-4952-8cca-a5ea97d8c00d","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 \"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 \"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 \"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 \"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 },\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\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":"b735e9b2-f7af-4507-b24c-cf0cfde351e6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"12d82074-fb91-4f4e-a934-31aeb08cbf55","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4391cf35-555c-4830-910e-a21987a4872a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"54c5a213-9575-4b4e-b2d5-fe7ff48acd64","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"59c8a774-244b-4a51-b30d-539ca8b598cf","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"a988bccb-0d07-4878-9394-97be76f1adec","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":"1319c733-965a-4078-bcef-b8036b30bef5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0c0ae94e-6633-4726-935d-f7aac6e4420b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"987ab979-a06c-4214-ae31-5a0ba147afca","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"eb9edeb6-3c1c-4a72-9266-30aea0d3f6b1","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 }\n}"},{"id":"25eb28eb-22a8-4689-b83c-0056e79b40da","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d4281911-cc81-4d98-9e42-33c5b44702a6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"47ef9fdd-c79b-4945-964d-7a2855ced1b0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b7d3e7bc-aa92-4b2d-ad0f-0f39d8b8753f","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 }\n}"},{"id":"b62bbba9-ee3b-4fed-9a5d-6bea51e849ec","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cfeb593a-c07c-42f2-b38d-3a4b0b43afe0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ccaaa6fd-8169-4efd-8eb8-4a3b4ea0c62b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8a48c76e-cfeb-45a7-94dc-fb8f989ce231","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"3e1fdc5b-7d70-4c0c-a6bb-88c43d7022ea","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":"07a480ca-ff39-4d89-868f-67039c67b45a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fcba2efc-c73a-4d19-be6b-faf06c413690","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8bd14552-8a3d-4ca7-833f-1ef11b6244f1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"15dc0904-1467-426c-a754-88bf39ec6e23","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"86f5fb4c-9e74-4eb0-a11a-037d5292d487","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 \"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 \"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 }\n}"},{"id":"99ba31c8-3a21-45b4-a17a-a5c3d37e9bf6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e8e87b79-17a9-4877-afeb-9a6de3e427bd","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bd744bb8-621e-4ea2-9fe9-e7d28e206185","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"25bbf2ad-2252-49aa-9c89-1ac7004178d8","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":"364cadfa-2d30-402f-b90b-05cd40c46abe","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"14a594ad-c875-4cf2-bd0b-33e09cdc9eff","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"874c0870-f8aa-446f-8f2e-59bab229e610","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 }\n}"},{"id":"2c115497-d533-4683-bd50-2bd196766a7f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"106674b6-bdd5-416a-898e-3fa4f6b71944","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b20320d3-7300-4e43-832a-11dc35330501","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9da012f1-7e47-4205-a45d-f506230b7622","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"4e9d1fe3-2b2b-4bad-9694-aa6d549613f6","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d1bb039f-8051-49d7-9689-4e1909a90e9c","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":"67870855-b19d-4226-8044-ae52d1f511b0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f5397954-1916-4efe-aba3-f9bba9c50a54","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c7508f73-f4c2-486a-9e9f-574d9baf7e52","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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]=&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":"

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":"87940d22-3a90-4464-b90f-c6af2241ffe0","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]=&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":"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 \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"588b10c4-055c-4427-ae4c-24177970b206","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]=&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":"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"180e8fc6-c961-4fd6-9bb2-9e879f9886b0","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]=&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":"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 },\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":"41db007c-b995-442f-863f-95f516784349","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 },\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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0b425814-4de7-40c0-a2cd-73b4a02b5a61","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"61baaf3c-0049-440a-8067-a0a5af876d9a","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"15b8cfe8-ed2b-482f-9e48-92f423e49e7c","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"0c310cef-6499-4264-9c55-29a1af99302c","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":"93f89d31-f8cb-4aa9-9768-7ea618c669bf","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f534d9cf-88d7-4997-9b0f-6d5c938f8896","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c88cd8af-403d-48bf-8c10-fa7633aa426a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f418cfa7-d8ef-41f1-a4c3-28b292cbe9d2","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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ca4518c7-ddf9-4587-bb84-288b7650a690","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d7248008-d28c-4c76-b10d-405529c1f08e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"47d2ece0-24d0-4791-9d11-980de6bc3e8c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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 },\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":"ce4e35ae-a04f-4c08-bc7e-5ca13e430e5d","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 },\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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7db68d94-380a-48f6-860c-18667cd23184","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"de9d0094-6e17-4215-8c5b-6765b8c51867","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4406d83e-3df5-4493-9171-5eed1f711b08","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"85610931-3ee7-4dfe-abe9-359aca159f7e","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 },\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"3ddaef8c-78be-4b20-a6a2-acb77d351715","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":"3fdac93b-0f70-405b-9172-4a46ea7a97fc","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"83abf18e-3060-4cf6-805f-94d011b6696c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"128dbaa7-0c10-4bba-8b22-044cdd340c8a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5afa265e-ffa8-4241-92ce-2d388d83a6d5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b7dac12c-f8a0-4f83-a33f-af02ab0c9a55","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":"11abc67d-b5c3-4587-9037-e5ee14f1ea7b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e44fdb7b-1596-4284-b628-bc326379bc5b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5e835b36-aaa7-4a5c-8baa-ec9e8fb06e28","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"5760ce4f-2c14-4a5b-86a6-a9ab97cef117","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"730544d5-28f1-4afa-9df8-b9b02ff7c96f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a445904c-80bb-496b-a9bf-27b80c7263a0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f95c5ead-4a1a-428d-a03f-c673e9ecb078","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"e6062177-0551-479d-ba2a-36a7af9e0274","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"69aa4424-4e2b-4235-a877-27725e73d2e5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"de57669e-8a03-4306-850b-1454aca18acc","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"221944ef-15a0-498b-8c0b-8c12214b9fda","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3350937b-1f9f-417b-a05b-5abd8b885fea","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"19c736db-6289-497d-8035-0e3e2333a4ee","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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":"3ae22160-f51c-4202-b759-2e75199b5c64","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9ef75f83-f462-4134-94ef-2a109b65a9bf","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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-3d-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":"74da5a5c-3d7a-4d3a-a986-f22f4deed51d","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-3d-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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"46bc62d7-e126-428b-b29b-30ae61d1cf13","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aa82b340-fb0a-4042-9469-77770a61ba1b","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9292d423-e195-414c-b372-b7851fe3e9ad","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e9a4c710-2b6c-4bcd-bdc6-c07c6c935d61","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-3d-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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"4cd9b1da-2e74-4c89-a189-89c14d9ffd30","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 },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"371f91ec-66fc-4c15-b041-bfe512e14094","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d1d1bb6a-408a-4e6e-80e7-cc60f7921d2a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"fc63f38f-eabf-4c08-83ea-6d024c93811b","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 },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"981010a5-49cc-4122-aa8a-9e39ee5f180c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ffc6576d-0b08-4f2c-8b9f-74eabde48574","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0191a52f-daa2-437b-bb32-29ec5eb22e9f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"75b04d28-f4cd-494d-b5a3-c540ffd814a9","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"2032d747-abbf-4645-a341-e81afb9ea769","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"760c18b2-0229-4e6d-a0e4-c521d434a061","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f9a51667-c40a-48f8-9d93-188612e074de","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ece0691d-0109-4f70-913d-b50f62e575d0","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 \"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 }\n}"},{"id":"c14d51e0-afef-4e51-bf1d-914099b2076b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1c561b5e-4cef-415b-8441-0d1f226b0d7c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ba0a3f02-a2cb-49e2-9273-0ff19a21b702","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":"7307ae80-bb01-4630-a3de-0883412f1f83","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3bac0337-c1f6-4569-ba85-3ec4f2082a0f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c23f78fc-d42c-401b-bf52-4145fd835f11","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"c0b93a7d-71fb-412b-bc41-341653ec27bd","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\": \"open\",\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 }\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":"7e87a41b-1b22-4d61-927d-fa8b2a6842d8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bd02c1d4-da6f-486d-9f3a-4ec67045f53d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"635bc197-6acd-452b-8711-5eb415944905","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"8b6a3c51-c037-4a48-bf6b-c2ca6e177471","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 }\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 }\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 }\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":"9c3a494f-9494-4ef0-87a9-b417d73917c6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e1b503eb-5a9f-4e82-a65f-6c3251074598","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"840406e5-769f-46df-8a7e-5cc95b84f3af","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":"0242fe3d-a7b4-4712-9cd8-5bd3f694f147","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"56a3fbb1-5f51-43ea-af8b-26357d113fef","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"a21bae1c-e132-4447-8a9f-4cb2e9b97663","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\": \"open\",\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 }\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":"a0ae5457-3c12-4a95-be33-04898951e19f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"189227ef-8525-4c5f-9237-b8093bd9b190","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"23fd1544-415d-43f8-b55d-f533b9b3269f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"1cd51315-3999-4bbf-9fa0-e1e33763638e","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\": \"open\",\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 }\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":"421a4911-574d-4157-ae58-48bf2682ddfc","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"82cfc59d-d365-426b-954e-b5923c251ac8","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"261f3504-d861-4fd5-a8a0-9424f81a2a1d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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?page[cursor]=&page[size]=","description":"

Get a threads users.

\n","urlObject":{"path":["threads",":id","users"],"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 thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"72e572c3-5b27-4eb9-a63f-3591c59f569c","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"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 `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 \"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":"9f94a0f7-4eb1-4c5d-804b-782372474f5a","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"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 `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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b732b521-5652-428a-9d3f-1fff2da72dbb","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"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 `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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7755e086-6137-4ce7-bf2b-10740ca1e155","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?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"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 `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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"d660dd8d-d294-4ffe-88d3-097bc6a557af","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 },\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 \"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 \"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 \"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 }\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 \"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 \"code\": \"\",\n \"detail\": \"\",\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 \"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 },\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 \"key_4\": {\n \"href\": \"\"\n }\n }\n },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ]\n}"},{"id":"4e9bd7fb-4372-447e-bc38-b1f2ff55fe71","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cc71c7a9-ed1f-4a4b-aed8-5369a193ea9d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"51e43f05-4e32-4e73-8cb8-f8cf41d4a2b4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"863c63c7-f356-430d-8c32-7852b147583e","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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]=","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":""}],"variable":[]}},"response":[{"id":"a5396152-fbad-4260-b60c-40da0a20c23b","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]=","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":""}]}},"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 },\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n },\n \"key_4\": {\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 \"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 \"key_2\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"key_3\": {\n \"href\": \"\"\n }\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 }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"499d6744-a364-4d18-8cbe-e7ac1e817763","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]=","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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2d449698-7bef-4ff9-909a-16f5c5959ab4","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]=","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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0e49b3fd-cf8b-4671-9db8-1ca3d80805e0","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]=","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":""}]}},"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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"36e3c68d-f547-45dc-bece-b5e38c2ded25","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\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 \"key_1\": \"\",\n \"key_2\": \"\"\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 }\n },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8a30cd89-0592-4f4e-8475-26a3ded6a1c6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e7372155-10df-41e7-87b3-490154893d2c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ab683e28-3091-4db3-b951-691c46dc7a81","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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. This endpoint always redirects (301) to queued-translation-jobs, preserving the pagination and filter query parameters.

\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":"4b34c1cf-41ec-4e1f-8225-c6343d4f87c8","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":"647af888-d75b-4472-96c7-78bfb415dfcd","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"60d657ba-cce2-4e5f-93a7-811e0f883a6b","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"949261d9-dc22-4a72-a154-3db8fd983519","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"28299a24-aac0-40da-aae4-0dce10a25707","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 },\n \"source\": {\n \"parameter\": \"\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7e9dc223-b089-427d-9d43-0606fb554a2b","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":"b57f6696-c0f9-4df1-a23a-299e304812fd","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e909e20b-a52f-45f1-9995-c41ca1935907","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9d8cdf03-b262-4830-9c3f-0a76ecf863e7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"464f96c8-1e45-4b74-b65e-2f045470cafb","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 \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9c72e4a7-5861-4bc3-8a49-3231561b39fe","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0231e341-110a-4b65-9d22-c9990b215c9d","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8912e501-c2e4-4527-90cc-6328c6279383","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"34fc53bb-a558-47d1-935d-384d73549a95","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 \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c82aef2b-14a9-4ffd-a4ef-2e37a7e66538","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7923bbd9-4d7f-4e46-86b8-6b9dbdf2d07c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4c2b42a2-613b-4d74-bf6e-229c3e49874f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"925c1f23-14b0-48c8-9ffd-4dcf175bc427","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 \"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":"5a96ba12-fd08-4629-aa33-4573774799b5","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8383d58e-d3bc-4d27-a8c7-e046c52a5da1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3a033609-bb71-4bc1-93d4-b6fe013be8d7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b5bf84c0-0f88-4114-87d0-699f6aa328ec","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8a69a815-0665-4448-9468-ec8e7cc50f32","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b748eacc-92ab-4559-9b4d-100dbe4165a9","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"555246c3-fecc-4225-a8f4-a1bbcdd3d009","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"b0eac397-dda0-415e-a4b3-fbd7439025eb","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"34ebdfea-3db0-4986-b45a-c6b8b1d01996","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c1237934-a829-4361-89a1-514a813c4011","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d9399184-32ec-4eec-8e1d-60731c3e5205","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"ecfe5737-1563-47c0-bc1f-a27d6c959967","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 }\n}"},{"id":"90a3508f-7da4-4817-8f2b-e93e09f2b338","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ca3adcad-ae0d-43a5-8a64-da77e89817b2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"69b69c30-b602-43bb-92c2-9db8e98bb1f7","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f9846c93-c699-4d3c-8df1-4a2cac7dc603","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 \"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}"},{"id":"d2b239da-1d76-4d1d-b264-f31d7615de5f","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7c7f92ed-b15d-4aaa-adc4-ecdcbd510c5a","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"913afe20-206f-445d-b01c-afc660c0a4b6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"c32e5d5b-ce12-4002-bc3b-160949f89be9","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/user-groups/:id","host":["https://platform.vertexvis.com"],"path":["user-groups",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user-group` 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 \"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 \"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}"},{"id":"e59ded89-a5af-40a3-b575-4df1f06cc2bd","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"28cb46c0-20db-402f-a8bb-553ab1f71283","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ab603021-d30b-465f-a39d-deb4cb677eec","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"9cc99746-dcfd-4bdb-a11c-ae3a501e4cc5","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":"1ad82618-8b44-4b5c-a737-581ce6535a32","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3bafc50d-a9ed-4ddc-b5d2-8dd0519007b6","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5bb30517-534c-4fea-ad52-8f83a4ad5fb1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"f8ece8cc-e0b8-42cf-8a07-28b960a7ec8e","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 \"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 {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"active\",\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d64cd451-316c-4868-a374-c59f216806c4","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"39647216-4035-4cab-9f3a-8f62f4565270","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"33508302-cf75-4411-bf3d-d8cd643dccb2","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\": \"active\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e4081290-3e0a-41a1-ab4a-3edf91b21b14","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c4d0d4fa-c225-404f-b638-9cb5ada60ed2","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"c67257c7-3da8-43ce-91bc-fd055ed6128c","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":"cc8aa319-9489-410a-b4df-9eff4305530c","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b4136577-a238-4781-a94b-5e9d48da7cce","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"13c57eee-ba33-4592-8ab9-0a25b6afe5d1","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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":"1e8ebcd9-c85a-4865-9272-dbab533c4581","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\": \"active\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"03e0d44f-b6bf-476f-96c4-2ad85bb1e318","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"259ece43-a1c2-4f3e-b552-cf8e9affad35","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2d541684-ffa8-4e81-b147-c1a7baba17c0","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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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\": \"paused\",\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":"6246fc38-619a-47dc-943f-54284a497203","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\": \"paused\",\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\": \"active\",\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"839f2ce6-06e9-497e-ad96-c935f8c9d4e6","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\": \"paused\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b98c1593-55b0-46cc-afd8-1eac90084420","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\": \"paused\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"dd82f5da-72de-4a7e-9040-b4c731ee140c","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\": \"paused\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3173dfdd-601d-4d3e-8078-c48c487344b9","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\": \"paused\",\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 },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\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"}]}