{"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":"d0fde5da-ca1e-4dbb-8de3-341a5883964c","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":"d17e94ea-5f8e-46ba-8772-0ec5c4ce21d8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2b11cb32-1ffc-4c73-a1a8-fab143503c62","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d536ef70-c769-47fb-93b3-e68e4d23bd96","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"6daf10c6-6fc0-4b74-bcf1-7d9711ea44bf","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":"de17b08d-dcad-43be-88e0-9b43e955b66c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a055657f-c13c-475d-bfa1-e4919a3ef690","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4eb79b94-afa8-4fd4-a8b4-101e87b2a8a9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"34c5e4b8-3e39-4216-8ffd-bcfb6320081c","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":"bdbb5a8e-f510-48b8-a036-d5e5ae66db18","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a733694c-fc21-46c3-8aba-f6fe8791bcd3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aa8a1c0f-5930-45b0-94cc-afa1387571f1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/accounts/:id","description":"

Update an account.

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

(Required) The account ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b6700642-aaf6-4ece-82c2-060cb67f17ab","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7a8e0350-df9f-4d8a-8c69-cf9c0e0122a7","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"98dbfb92-a090-4849-8610-dcd5a56ab1ab","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"81f176ff-f235-465d-959b-7a55d032d05e","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7242cede-01a6-4004-b573-34b53738152d","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"owner\": \"\",\n \"status\": \"disabled\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/accounts/:id","host":["https://platform.vertexvis.com"],"path":["accounts",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `account` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"81bca2fd-eec9-4de7-98fb-c6e95f2511ca","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":"1cce276e-6c7f-47e2-966a-ad7f8cdddeab","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fa94006a-4067-4309-af74-1f4e60ab680b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"351e0371-fa81-498b-8695-2b1acc882d93","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"efa3c429-be8e-42e5-acdb-7149851cb7a8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"0f72d1ca-9644-4694-a59e-16ec166c0b77","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/applications?page[cursor]=&page[size]=&filter[clientId]=","host":["https://platform.vertexvis.com"],"path":["applications"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of client IDs to filter on.","key":"filter[clientId]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\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":"cb939de1-18ee-4082-be38-a45b46205bd7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f11c8ec2-3535-44c8-b952-8940dc388a84","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications","description":"

Create an OAuth2 application.

\n
Body Params
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescription
dataCreateAccountRequest_datatrue
▹ attributesCreateAccountRequest_data_attributestrue
▹▹ namestringtrue
▹ typestringtrue
\n
","urlObject":{"path":["applications"],"host":["https://platform.vertexvis.com"],"query":[],"variable":[]}},"response":[{"id":"ad3d9a3b-7f86-4c68-868e-e9ad22177a42","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\"\n }\n}"},{"id":"bf2be835-e923-4e01-b4e3-3500c7796652","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"42c65cce-a8ba-4cde-bfb4-af4f8ec3d26c","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6bba3522-7d26-4e62-b78c-739bbff057c1","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications"},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"e9626d69-dc34-49bb-8909-2ee443d116e3","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":"9ba142e2-4e45-420e-b904-318607d17e00","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"04155bd1-bda3-4521-9194-8b3ba120b3bd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3207918b-51ee-4d50-a7b7-c0a21c05bf2a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"cae0aea2-08bc-4377-9b5f-ce3292601809","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f5935970-5b1c-48e6-8b7f-88e22f7a1882","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ccb447c2-fbb6-4d9c-83e5-dafc6b26575b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8237f74b-62ca-4a62-9cf7-536701606672","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/applications/:id","description":"

Update an application.

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

(Required) The application ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"b420fc91-632b-4aa9-96c7-b57ddd519392","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"clientId\": \"\",\n \"created\": \"\",\n \"name\": \"\",\n \"redirectUris\": [\n \"\",\n \"\"\n ],\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d821341e-8fc6-42d8-a95b-2bced9ff2ab5","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e06e4890-6852-49b6-8a73-ab189ae99d89","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7da93c2c-5373-42bf-96ed-bc1bfb668474","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"be300510-4cba-4c42-8459-66c5361fac1c","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"redirect_uris\": [\n \"\",\n \"\"\n ]\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/applications/:id","host":["https://platform.vertexvis.com"],"path":["applications",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `application` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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]=thread&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":"thread"},{"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":"fd049dbb-7bb7-4d23-aba5-7e01c0a3efed","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]=thread&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":"thread"},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"content\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"type\": \"file\",\n \"size\": \"\"\n },\n \"thumbnails\": \"string\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"relationship\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n }\n },\n \"type\": \"\"\n },\n {\n \"attributes\": {\n \"content\": {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"type\": \"file\",\n \"size\": \"\"\n },\n \"thumbnails\": \"string\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"relationship\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n }\n },\n \"type\": \"\"\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"977d355f-e1b8-4397-a119-a5a4eda53532","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]=thread&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":"thread"},{"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3a591d48-6a74-483f-8558-277d33c823c8","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]=thread&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":"thread"},{"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ff6ea0c9-6275-4c25-a59b-fc4bcee6e087","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]=thread&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":"thread"},{"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"05c88d1d-3993-4575-9be1-77f7673e0124","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\": true\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9bb6d1e1-cae5-4c0a-89c2-fd7c088e60a9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a2cadd57-a538-4e67-a418-c362f311ac0b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"14cb30c8-bc41-4f06-8ef7-9a6b8ae3d0cb","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"19e4ef91-962b-47aa-8320-5e03a4d8aaef","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/download-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","download-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8df0cb9b-f3ca-426a-a32d-f6565e035885","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bda0b67b-fe6b-4067-8c9f-4919b9451f97","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e4ecd535-9436-4769-bd4d-2f9eee3c91bb","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"1c478a58-2255-4f75-8032-02c2b4f4156c","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/attachments/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["attachments",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `attachment` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7df84991-8acd-4a9d-9b08-1e104cc1b51c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"54537c84-17ed-475f-8307-c2674c57239f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d090c39e-fbdc-4930-879a-6a2772afc5c9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-iteration\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_3\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"add\",\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":"d70b938a-cc8f-4c72-a420-c0a56cbbaac0","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 },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-iteration\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_3\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"add\",\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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"69b744b5-55c8-4936-96ca-292af05b0adf","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 },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-iteration\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_3\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"add\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0bb964ac-edf3-4aaa-84e4-5f0ad25f351b","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 },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-iteration\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_3\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"add\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e664f945-ea2a-46e4-9093-82722034277d","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 },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-iteration\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"remove\",\n \"ref\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n {\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_3\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"latest-revision\",\n \"source\": {\n \"suppliedPartId\": \"\",\n \"suppliedRevisionId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"referenceTree\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\"\n },\n \"op\": \"add\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"88e611fe-042e-4567-9b02-39afedc7755d","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":"9fadd6d3-0863-4a88-b319-44ecf2287355","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"615707da-2228-4b35-86e4-c948441efc7c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"19283001-8288-4e7b-80d6-10ab39472b3a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"d84fc05a-3118-4aa2-ada5-c677b982f605","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7ffc6d22-9335-4208-bb06-857113c7c4fe","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":"11e0f3f7-da42-41fb-830e-71a286a8cb98","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d23cc743-5153-495e-a096-826dc9a966eb","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4d9d07d1-fe20-4735-9138-e7f7c3706688","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"1777656f-ec0b-448c-b60c-9a792d1cfe0b","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 }\n}"},{"id":"8307104d-e00d-4530-b8fe-ebb9a5b9ff8c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d1729255-7616-48b7-9987-540959a471e1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0bee8db7-9e76-4caa-93f3-7a343d72f723","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"e719ae24-2080-485c-96ba-76592432d095","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 }\n}"},{"id":"2bdc8142-814f-4a10-904a-fb156bd074f6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aa95cac1-0db6-4b30-be34-f641a790cb0d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c75f5529-44ac-4944-a8c0-c642cb243124","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"c724d99a-3f8d-4cb4-b40e-77eba88b310f","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":"4666b9ca-4a9c-4389-bf53-1a1b13d3479b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"59ba37bf-6e3e-4613-9284-763b411f5a0b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"008ebf6e-6ea0-4493-9b46-e2993f341b5c","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 }\n}"},{"id":"93a55998-4464-4515-b44b-a888c23b3f49","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bc3f2a77-bbe1-4638-b770-e23244dbe394","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"37678569-f06e-4fba-b1c3-a381182f1cc6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"49886700-1fc7-43ce-a58c-ff8b12bc961f","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":"98807277-6ec1-46a6-9a75-5a9e756e3de1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"68766f4e-682e-425f-b995-bdd6a893eed6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aede8d44-2d41-40a6-8810-e3c64dcf35a0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"18b0d1f4-9a24-4f1d-89cf-e030c55b3749","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 }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f7faaa5a-597f-4760-975a-8715333a6fac","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"43c10bec-72e3-4f2d-b065-f580b2ae56b5","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e46df80c-80a4-4d39-91fa-7a74e0919c1e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"4d71255c-b811-44f3-a955-e5fe91673fbd","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":"37ad8fb5-bf80-4659-a178-eb5b59a7c8ad","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1888042d-1f5c-42b2-9ee7-5a60439c8ac9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"3b6eaf19-8554-453b-8684-883bc58321da","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"document\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/documents"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"documentType\": \"PDF\",\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"document\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"6500d9e8-53c6-4969-b03a-01a329a55afd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"24c49d0e-7560-4fdd-9985-d324b0ee9709","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5893945b-0e83-4a71-b9ef-50a41f7b1aff","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"e52603d7-1b31-4d9a-90d2-cacdbf5d9c0b","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/documents/:id","host":["https://platform.vertexvis.com"],"path":["documents",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `document` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"documentType\": \"PDF\",\n \"fileId\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"document\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"73d2891a-2220-4f3b-977b-9c4d8bf1b211","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2a19f9ff-1127-4383-a9d0-47dfd93d983e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"37b8de6f-01d5-4b22-81da-48a91ae84a80","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"afa2b389-980f-49bd-beff-654729c4a353","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"65fd4eb6-36a3-4e00-b5de-679568666745","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cf46a582-7e36-4147-aa24-3b4695e61435","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4ecc3480-6b64-4fec-a334-0594eb188ae7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"e040662a-61a5-402e-94a6-f4b8ab4e158c","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 },\n \"relationships\": {\n \"file\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"file\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"10be1584-7e68-400c-a774-e469658cda08","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"af3d19d1-78de-4076-8071-1ed462eda9a3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3c6863d1-a20a-472f-acb7-1aac693416a0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"8736a1bb-2c8c-4876-9840-e7bb7eec37cf","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c90f7656-516d-4a29-abed-dc9b7cd4a63f","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":"1b064936-8dd5-4c15-9422-a3c9a51f7314","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"19566526-0335-43fd-a7c3-3ee8cbc35677","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"254b3b03-ab02-4ee8-bc8d-b7cbeae56710","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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=&contains=&eq=>=>e=<=<e=&neq=&contains=&eq=>=>e=<=<e=&neq=&filter[suppliedId]=&contains=&eq=>=>e=<=<e=&neq=","description":"

Get files.

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

The cursor for the next page of items.

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

The number of items to return.

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

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

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

A filter expression for the name to filter on.

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

A filter expression for the name to filter on.

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

A filter expression for the name to filter on.

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

A filter expression for the name to filter on.

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

A filter expression for the name to filter on.

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

A filter expression for the name to filter on.

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

A filter expression for the name to filter on.

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

A filter expression for the fileId to filter on.

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

A filter expression for the fileId to filter on.

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

A filter expression for the fileId to filter on.

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

A filter expression for the fileId to filter on.

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

A filter expression for the fileId to filter on.

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

A filter expression for the fileId to filter on.

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

A filter expression for the fileId to filter on.

\n","type":"text/plain"},"key":"neq","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":""},{"description":{"content":"

A filter expression for the createdAt to filter on.

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

A filter expression for the createdAt to filter on.

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

A filter expression for the createdAt to filter on.

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

A filter expression for the createdAt to filter on.

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

A filter expression for the createdAt to filter on.

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

A filter expression for the createdAt to filter on.

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

A filter expression for the createdAt to filter on.

\n","type":"text/plain"},"key":"neq","value":""}],"variable":[]}},"response":[{"id":"fdd3c91e-476e-496d-b7ef-1f11105aef3e","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=&contains=&eq=>=>e=<=<e=&neq=&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":"A filter expression for the `name` to filter on.","key":"contains","value":""},{"description":"A filter expression for the `name` to filter on.","key":"eq","value":""},{"description":"A filter expression for the `name` to filter on.","key":"gt","value":""},{"description":"A filter expression for the `name` to filter on.","key":"gte","value":""},{"description":"A filter expression for the `name` to filter on.","key":"lt","value":""},{"description":"A filter expression for the `name` to filter on.","key":"lte","value":""},{"description":"A filter expression for the `name` to filter on.","key":"neq","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 },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3ba041f3-66bf-44ac-9ff2-0028b8b04823","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=&contains=&eq=>=>e=<=<e=&neq=&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":"A filter expression for the `name` to filter on.","key":"contains","value":""},{"description":"A filter expression for the `name` to filter on.","key":"eq","value":""},{"description":"A filter expression for the `name` to filter on.","key":"gt","value":""},{"description":"A filter expression for the `name` to filter on.","key":"gte","value":""},{"description":"A filter expression for the `name` to filter on.","key":"lt","value":""},{"description":"A filter expression for the `name` to filter on.","key":"lte","value":""},{"description":"A filter expression for the `name` to filter on.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"98732a0f-cd2d-46ef-a93d-b18165e35151","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=&contains=&eq=>=>e=<=<e=&neq=&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":"A filter expression for the `name` to filter on.","key":"contains","value":""},{"description":"A filter expression for the `name` to filter on.","key":"eq","value":""},{"description":"A filter expression for the `name` to filter on.","key":"gt","value":""},{"description":"A filter expression for the `name` to filter on.","key":"gte","value":""},{"description":"A filter expression for the `name` to filter on.","key":"lt","value":""},{"description":"A filter expression for the `name` to filter on.","key":"lte","value":""},{"description":"A filter expression for the `name` to filter on.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 \"key_1\": \"\",\n \"key_2\": \"\"\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":"eedb58e7-3343-420c-ba65-9be47378cd76","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1db8b912-ba0e-4efa-aebc-31b820f7e584","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"99669d9f-8f6b-42f7-a6d6-d0591768c72d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b0e166c2-563b-4b8c-a19d-a6d293f1c605","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"a6e4267b-3e95-4af2-b619-f6e00d7e1f89","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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d3ead734-7036-4009-889b-abf6eacea99d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1415efef-e1ee-4e39-ac5f-31bee0da7de9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9fdf9149-32d4-4959-84cd-06df4720aa83","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"af36ef11-fbf6-4831-b9de-f310ee58d2fb","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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3c8f9142-05c9-4d4d-b88a-c90a712eb514","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8af00b34-f818-44a1-90c7-d9ad18bf322f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4b9c4a81-3f94-46d3-a80c-246dd1e702b0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"a7bd5ea3-034a-4d8c-8c5d-92ed4cbdbe9a","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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fcc99b8e-e3ec-4788-8457-f53e7c0f24e1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1bd0a6dd-5461-495f-ab17-26cda5b209aa","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7de47bc7-734c-4440-95ed-657f3c934ff0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3c5f34fc-4cdc-413d-b601-107c8a3e8b4e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"92dc20e9-e908-4c33-858b-068dba53eb2c","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":"da49ddba-2450-47ef-9b48-d5db964fd622","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ae4a2051-4ba8-4d73-b1cb-d030390e9387","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d2c490b7-8621-4c39-8e3d-62a29e14e59f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2b6c1512-4d02-4915-b7d8-ac0d9470136d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"49140d8a-db71-42ee-be01-f9d04adcb4f1","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7dca0c7a-b938-452e-bfe2-360b893d0472","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"69de4ad2-24c3-437b-ad9d-cf36f15ceadc","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2cf0013f-48d9-4f6f-80cb-134d7abfeb44","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"aa35965a-ba71-4081-8f0a-2f732f394b58","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b6625686-a4ee-4854-bdad-28b2e4d7d01a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"9b8daf1f-12b7-41ba-b3cc-03364cb05116","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/files/:id/upload-url","host":["https://platform.vertexvis.com"],"path":["files",":id","upload-url"],"variable":[{"key":"id","value":"","description":"(Required) The `file` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"uri\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"377dacd1-f372-4d26-9113-b05aa61e86d7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cb74b5cc-dd38-48f8-a226-100431c1d57f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e421c766-a277-4454-be18-9a51cd6a404f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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]=&filter[suppliedId]=","description":"

List file-collections by supplied ID.

\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":"

Comma-separated list of supplied IDs to filter on.

\n","type":"text/plain"},"key":"filter[suppliedId]","value":""}],"variable":[]}},"response":[{"id":"20cd0611-40c1-4a66-9cf0-2d07c130cacb","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections?page[cursor]=&page[size]=&filter[suppliedId]=","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":"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 \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"2349ee9b-4dc4-44a5-9612-a893b7404057","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections?page[cursor]=&page[size]=&filter[suppliedId]=","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":"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 \"key_3\": \"\",\n \"key_4\": \"\"\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":"34e4c692-1404-4a47-a096-92fa5a579deb","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 \"key_3\": \"\",\n \"key_4\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-collections"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"38bae5e7-82ad-4269-b6ab-94baeb971c63","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 \"key_3\": \"\",\n \"key_4\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"45975c52-6da9-4219-9d4f-3ba0f22dcfbd","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 \"key_3\": \"\",\n \"key_4\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"0bfc2984-1c4f-4035-a453-6ee64a8d4055","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":"dc780983-7ea6-4a2a-a7a2-068878bc1016","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9443c1ee-6b83-4026-83d4-d532388a31e1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"5c085694-2ec0-4471-8ba2-e582d01276a4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f3bc6f29-fa3c-4aa2-85d0-d97b1508430b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5daced8d-dd04-4280-90ca-b1a9ebaa9254","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 }\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":"9d09dbdf-1be3-4132-9d51-77ba9153379b","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"a764407f-66dc-4eb4-9eeb-d02df5d86c28","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9f0b46cc-c782-413d-b6c3-55637fd42637","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cc0b71d2-333a-4c8e-990e-101777a208f7","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n \"type\": \"file-collection\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id","host":["https://platform.vertexvis.com"],"path":["file-collections",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"db40ed96-d551-4e22-bc1a-6b6e85b1f911","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":"72cfc0b3-50bf-46f0-895f-d19a980866d6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c695b767-bb3a-4ab6-b930-110049d1cbd2","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"6a1ddf9f-b6b6-4825-bb0b-5c6535f9a324","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"status\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"rootFileName\": \"\",\n \"size\": \"\",\n \"suppliedId\": \"\",\n \"uploaded\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"032ff65d-bc3e-47e7-98e4-a220f841d253","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1236fc67-27c5-4034-8603-c83e3b2f909f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"fb5b9651-bd5c-4070-ac2e-2aed157c4fd5","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/file-collections/:id/files","host":["https://platform.vertexvis.com"],"path":["file-collections",":id","files"],"variable":[{"key":"id","value":"","description":"(Required) The `file-collection` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"file-collection\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"0629f9f3-8dd8-49c9-9fe1-9fde3376553e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3c4939bd-8b5b-45d4-9b26-42d4dda37486","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e2d53964-d3ee-42bf-a1dd-9ec51f7d57e4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"993253e2-70b8-4a45-9a61-f868d9a109bc","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"operation\": {\n \"fileId\": \"\",\n \"manifest\": [\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n },\n {\n \"selector\": {\n \"id\": \"\",\n \"type\": \"file-by-id\"\n },\n \"directory\": \"\"\n }\n ],\n \"type\": \"file-archive-operation\"\n }\n },\n \"type\": \"file-job\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/file-jobs"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b93e4fb6-b06e-48d9-86a3-74871c53ae30","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6ff1ae84-d492-4dc0-9684-b8c14e1540a9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"f5198699-77fa-40c2-9d58-f07d2e9f7ca6","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e79d4783-3727-4e93-af5e-20267b79f343","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e309a3bf-69ed-4ae5-b8ff-be94345cda33","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f045be1d-adf5-4c85-9c84-0eb12a6bab82","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"4c3dddfb-61ff-44b3-81ae-fcc7bc819e5a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/geometry-sets?page[cursor]=&page[size]=","host":["https://platform.vertexvis.com"],"path":["geometry-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"90497169-62b6-4670-b25a-583ede484054","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6d75db8c-7bd3-498e-bf47-ec194c0c14f1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"86681dfb-7eac-4599-b2a4-957ca9fcb747","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"122c4870-3fbc-49b4-b63a-929ef37576cf","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ea7b89cc-fbe4-444e-be6c-84def697a2db","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"454574cf-9eb0-464d-9e18-657e47bc3969","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"0a50d13d-75d2-44be-bfe8-94603c25ef2c","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 \"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":"5d45e015-19ff-4d52-816d-5b6a8164838b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b2a417c8-67a1-4519-823e-53c0b84e2b96","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7c4f9145-07ed-4d20-a8aa-550ce4f3d43a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"7123b7d5-254a-4c45-bc3d-0f71c376ef71","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 }\n}"},{"id":"d1189935-e890-4c4a-94e8-4f793985ea05","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"634767e2-870e-4bcd-884b-c181e828e580","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ac25357d-3aeb-40c1-9a6f-07b19bccb878","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5852218b-38e5-41d8-8954-80cce2e197bc","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"7c932f70-60b9-4d68-aefc-a8e9e9241272","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 }\n}"},{"id":"0550a2a6-6685-4071-80f3-63ef54f8ef59","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6c0d0668-0eb9-4226-8d2d-41c06e879090","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b428a9f1-f21a-42b0-8a45-4dfa948020b8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"35985205-9759-4ba7-ae34-f6892ed6380f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"72be21f5-dc90-4ed0-b644-f46f7b87aacc","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/model-views/:id","host":["https://platform.vertexvis.com"],"path":["model-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `model-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c9ee9bcc-a7b2-4742-954f-ce4483a9373e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"516c4279-7b6a-4905-b9e6-4d716391e9a9","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"37cddd5d-f498-4787-8b24-a50f175b285e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"5afc70d7-71de-445b-9ea6-1c97b634d17f","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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f1d14eb8-a999-4c60-9b53-03a3f1c76dba","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"24361ada-bd37-424d-8e7d-cea0ac082729","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3d8055aa-f9e2-46ed-926f-54b7f1bc5f16","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"9909a91e-89fd-4caa-a011-ba7f2732811e","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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9ffcbc24-7f23-4f34-b8c1-102f09cdd81f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8b101f67-7eaa-4eed-bc5c-0856b55c4da3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"01b27bc5-860c-47c7-9fa3-cb87220e53c0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"d4a2ef56-1757-44a2-9bc2-41d7b7bbbb5e","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":"6b7d924e-8a80-45c8-a8dd-a2f28d357087","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a9cf6a6c-b459-4fed-93f9-5db26f749c55","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"e493f46a-fbed-4393-b451-14df87497923","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":"7a5c82ce-6e33-402f-8e63-b840724e218e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ac648070-7923-43cb-9da6-22b5fbe90348","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"724984c4-7ea2-4741-9bcf-8c701ceb118a","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":"394407cb-6ebd-4328-a6d0-922452f5d8e6","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":"fd0e3b92-d4db-4440-bdf3-c6c015e2c621","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":"6b79beb4-dd78-4467-af19-ee8f91277352","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f6cd2c6f-6da5-4d6d-bbea-720dc625772d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7b7173d9-6dc8-435c-8763-dc2391ef130a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b51a4648-811b-4a8b-b180-279a566e45ab","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":"e4ed4505-14e7-4dfd-8341-66620defb5cc","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d5bcd43d-fc02-4a8a-a7a5-db098b0fe169","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f4b7f31a-f703-4437-ae25-bad5b73305af","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"e799d191-9f15-455d-94cf-e8eab739077c","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":"ab7e0e43-db0c-4a40-aed3-008c37e2aca4","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"91699ae2-7191-4e46-916c-b498d8bef550","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"84d8836e-0702-448f-8417-60cdb5859974","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"eb469ccf-65ed-4466-a08e-bcef62a2d020","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b871521d-4aea-4883-9d38-f6e87eb82a26","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"6c960d55-9056-4170-955d-290aa7d5d1f5","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f78a7a34-d43a-408e-8d10-859c825d596b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d3fc2b01-8ef3-4e58-85ad-9ec541beab01","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4d942142-118c-421f-ba5e-6158262a7d32","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"8bd84585-228e-4193-99be-2e49b73d4baf","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3181ca5c-608b-4c25-883a-f2a1b59472cd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"95d71513-2bdd-4deb-98ea-d3c384b220e2","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"82d15144-3320-4a74-82f0-111794eb09d7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 },\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":"ce7f7c87-0d62-4d3f-8798-e4d79d29fa5a","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 },\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5401ace9-e2e9-4491-9613-cce6c50db184","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 },\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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d87ab207-f29e-456c-82a4-285a0fb7c219","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 },\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9693d1a3-3f24-4e19-8670-e2ccadc8dd6e","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 },\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2fb7fbb4-41b0-4ec7-b3a4-eb72db7b79c0","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 },\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"82d284e1-72a4-46f3-98ab-3c4ffd8edc5e","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 },\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"1eff49ad-6f98-4ce7-8ea1-263987f82813","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":"92cccb5a-8f04-4325-a08e-27d8f50c6150","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"694e6d94-36c4-4b35-9153-528f87aa7e38","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"36cba313-7039-4f82-9dc8-f50b7b9944b8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ee6a6bc4-c0f4-4856-b058-e4544960ced2","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"8b35ce2d-603b-4083-9302-c8e2a8c6f09f","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 \"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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c3311a87-232b-4c2c-abd6-bf73a75f35c0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6bb7737f-18ae-4c17-91e1-bffb9fa293d8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f729a638-8355-4b8c-8f30-685493bc7d94","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"ecbd204f-9e1b-4bbb-9b02-21ab88722046","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"778d0dcc-f611-422b-8c92-b737296428c4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f4f06e1d-92d0-40f9-93b4-0f2b6767d6b4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b720c5c0-5043-4907-be3a-3a2478cf54c4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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-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":"7677e50b-4fbb-46bd-9349-bd8289afa3ad","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 }\n}"},{"id":"3cf2bd1f-fff7-4078-8a50-47858c8708e3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"31dcd3bd-8af6-40c7-9fd9-61ce239c7791","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"271ddbf0-89c1-4056-9d79-ca9d658ba93e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"08a61525-d942-4805-b1c6-039265ce8d61","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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[suppliedId]=&filter[ownerId]=","description":"

Get parts.

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

The cursor for the next page of items.

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

The number of items to return.

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

Comma-separated list of supplied IDs to filter on.

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

Owner ID to filter on.

\n","type":"text/plain"},"key":"filter[ownerId]","value":""}],"variable":[]}},"response":[{"id":"7b803dfd-a7bf-4bc2-b4af-d4c8b9315efe","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","host":["https://platform.vertexvis.com"],"path":["parts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Owner ID to filter on.","key":"filter[ownerId]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"partRevisions\": [\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n },\n {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n ],\n \"owner\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"account\"\n }\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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":"0db7ed57-81b1-4501-8111-df5bb845b6c0","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","host":["https://platform.vertexvis.com"],"path":["parts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Owner ID to filter on.","key":"filter[ownerId]","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b0aecb43-db72-4e09-be49-7114645b7ae9","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/parts?page[cursor]=&page[size]=&filter[suppliedId]=&filter[ownerId]=","host":["https://platform.vertexvis.com"],"path":["parts"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Owner ID to filter on.","key":"filter[ownerId]","value":""}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 \"key_2\": {\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":"4f21b929-fec2-41dc-a0d7-33b611dd3e7f","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 \"key_2\": {\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 \"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 \"included\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"58bde12e-c614-4028-a1ac-de4d435a32f0","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 \"key_2\": {\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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"b4f178ea-8214-4b09-bb22-431e94a5db0d","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 \"key_2\": {\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"18098c6b-89bc-4daf-abb2-a219dd0eb82a","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 \"key_2\": {\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d6ee7418-7537-4c64-b454-190f4e885f24","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 \"key_2\": {\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"eea6f72b-95e5-48cd-a2c1-b8140b47c066","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ead8ed85-a6d7-43f9-ae6d-c11ec6197ecf","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f2da0633-e56a-4df4-ac2a-5930cb6b23e0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1e29897b-6088-482a-b28b-d720275ef828","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"7cc845e5-8c3f-43d6-8a97-3d626b5eae31","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 \"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 \"included\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_2\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"suppliedIterationId\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"defaultPartRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"geometrySet\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n },\n \"part\": {\n \"id\": \"\",\n \"type\": \"part\"\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e52db7e9-f626-4ee7-a249-618d3fea4112","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b7a10e99-1145-4d29-9c45-c9007e4feeb7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1e1c4880-43af-4d46-86cd-4693d2dc14ca","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"9ba79d61-a823-4460-949d-f189f8599b01","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":"eb69eccf-78c2-44a4-aa72-04f8d7fd1915","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"21035eaf-240a-4bea-9246-7a996c35490f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"dbcfe3b3-c9ff-4a13-a3b8-a7e300094108","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"56bb14cb-6f94-4efe-a054-0488a275b8cb","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"53b07574-55c4-4a97-9eca-82746819d841","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"94c90984-7ec5-427f-933e-8b79fe09447e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e95d606d-aa4b-4d38-aa5e-d7c8b07531eb","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"adf23a30-6933-4790-8cd6-828113d3d452","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 }\n },\n {\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"id\": \"\",\n \"type\": \"permission-grant\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f4b0e66e-af5c-4208-b3df-7543ddfb42d6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"f500a63a-3bb6-4ec6-aec7-0ba430706ea6","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"type\": \"permission-grant\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/permission-grants"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"capability\": \"read\",\n \"grantee\": {\n \"id\": \"\",\n \"type\": \"account\"\n },\n \"subject\": {\n \"domain\": \"parts\"\n }\n },\n \"id\": \"\",\n \"type\": \"permission-grant\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"13406dee-ebb6-46f1-b989-fd4736ff0706","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b9fbc77b-6594-477e-a91f-ab5185de6e37","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"909c0e49-677a-4308-be0b-60e30ac414fb","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b6334046-59cc-4ce6-baee-7698eb5aa89b","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 \"key_1\": {\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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ba7b851e-2dfd-4f00-ae62-41dc8505749e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"be83ca51-af0c-43b0-8e58-f643f8df3e49","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"dad811eb-6b73-4cb5-85f8-4b25622093b1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"735d305e-8c2e-49f5-aad7-90961cd324d4","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/property-entries?page[cursor]=&page[size]=&filter[resourceId]=&filter[resourceType]=","host":["https://platform.vertexvis.com"],"path":["property-entries"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A resource ID to filter on","key":"filter[resourceId]","value":""},{"description":"The provided type for the resource ids","key":"filter[resourceType]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"key\": {\n \"name\": \"\"\n },\n \"value\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"key\": {\n \"name\": \"\"\n },\n \"value\": {\n \"type\": \"string\",\n \"value\": \"\"\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"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":"7b85e40b-e1f8-41bd-b6f9-b9884b02744a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b978ed1f-67ab-4fee-8adc-b673f3b875dd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"5f1b5f11-f679-4f2f-97a5-87ecef1479ae","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":"5b418d8c-3718-449b-9076-d802416bbf05","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b28f2064-15c8-4f60-93f2-e6cc82a441b1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3e3ad9fc-852e-4d0f-8c2b-389e0416a949","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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]=&contains=&eq=>=>e=<=<e=&neq=","description":"

List property-key-policies.

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

The cursor for the next page of items.

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

The number of items to return.

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

The supplied ID filter expression for property key policies.

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

The supplied ID filter expression for property key policies.

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

The supplied ID filter expression for property key policies.

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

The supplied ID filter expression for property key policies.

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

The supplied ID filter expression for property key policies.

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

The supplied ID filter expression for property key policies.

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

The supplied ID filter expression for property key policies.

\n","type":"text/plain"},"key":"neq","value":""}],"variable":[]}},"response":[{"id":"776da712-84bf-4c51-8574-274b919f6a76","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["property-key-policies"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"contains","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"eq","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"gt","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"gte","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"lt","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"lte","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"neq","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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d877766e-f32f-409e-8cb0-92851996e00d","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["property-key-policies"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"contains","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"eq","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"gt","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"gte","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"lt","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"lte","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"035b15f2-f12f-4f0b-a124-89368e443c68","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["property-key-policies"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"contains","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"eq","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"gt","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"gte","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"lt","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"lte","value":""},{"description":"The supplied ID filter expression for property key policies.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"denylist\",\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":"72b800ba-c032-4211-82b5-8b149aebd308","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\": \"denylist\",\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\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key-policy\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5bdbd896-496e-4734-b6e4-78ecf35c94b9","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\": \"denylist\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a49b99cd-3f8b-438b-9232-875546d69960","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\": \"denylist\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"17abf50a-d1a4-454e-bed3-e02e34729e36","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\": \"denylist\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"09fe0c9f-b9cc-415d-8144-6f9bc17bd918","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\": \"denylist\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"2327c8e1-5670-4660-8969-b62d8e354343","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":"a648703f-3371-4fba-8211-9df8d498cb9e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2b9ae17c-8015-45ac-bd51-3169302b2ab0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"127f693c-29b8-431e-9975-e8c35c444d3f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"4512dfde-2367-49fc-ba1c-4c2d046b13da","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\": \"allowlist\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"property-key-policy\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"2cd4c51e-0369-4f2d-9360-58e2bd559353","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c95adaed-1b3d-4f7d-a041-908dec3cc583","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"32cd67ef-0f7e-43b0-a313-70baf6b88121","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 Entries","id":"delete-property-key-policy-entries","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/entries?filter[id]=","description":"

Delete entries from a property-key-policy.

\n","urlObject":{"path":["property-key-policies",":id","entries"],"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":"22d81b49-8b13-460e-a41e-75ca8407b1d2","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/entries?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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":"1d3323f1-b5fe-44f1-8c1a-247f819d9299","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/entries?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fa57e1ca-602d-42fc-834e-9d42bfe754a9","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/entries?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"326e11ca-73cf-498c-94b8-8a6994bc9f28","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/entries?filter[id]=","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"}],"_postman_id":"delete-property-key-policy-entries"},{"name":"upsert Property Key Policy Entries","id":"upsert-property-key-policy-entries","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/entries","description":"

Upsert entries 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[PropertyKey]true
▹ namestringtrue
\n
","urlObject":{"path":["property-key-policies",":id","entries"],"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":"59525036-5455-4139-a9ee-720138edf3b2","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/entries","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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":"b265da78-4f91-4f4e-8d77-4b86ff2e6592","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/entries","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"87495ee5-949b-4dbf-83cd-20bbb151ee50","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/entries","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cb792ce2-00a7-4ff4-8a9e-c9347b1a769b","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/entries","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d28355d3-3ecf-4e17-9826-5f94031c2ba6","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/entries","host":["https://platform.vertexvis.com"],"path":["property-key-policies",":id","entries"],"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"}],"_postman_id":"upsert-property-key-policy-entries"},{"name":"list Property Key Policy Entries","id":"list-property-key-policy-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-key-policy-entries?page[cursor]=&page[size]=&filter[propertyKeyPolicy.id]=&filter[propertyKeyPolicy.suppliedId]=","description":"

Get property-key-policy-entry resources for a property-key-policy. Accepts filter[propertyKeyPolicy.id] and filter[propertyKeyPolicy.suppliedId]. When both are provided, filter[propertyKeyPolicy.id] takes precedence.

\n","urlObject":{"path":["property-key-policy-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":"

The property-key-policy ID to filter on.

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

The property-key-policy supplied ID to filter on.

\n","type":"text/plain"},"key":"filter[propertyKeyPolicy.suppliedId]","value":""}],"variable":[]}},"response":[{"id":"94225e8f-2e27-417c-957a-478ec9d95c1b","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-policy-entries?page[cursor]=&page[size]=&filter[propertyKeyPolicy.id]=&filter[propertyKeyPolicy.suppliedId]=","host":["https://platform.vertexvis.com"],"path":["property-key-policy-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":"The `property-key-policy` ID to filter on.","key":"filter[propertyKeyPolicy.id]","value":""},{"description":"The `property-key-policy` supplied ID to filter on.","key":"filter[propertyKeyPolicy.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 \"key\": {\n \"name\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"propertyKeyPolicy\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-key-policy\"\n }\n }\n },\n \"type\": \"property-key-policy-entry\",\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 \"key\": {\n \"name\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"propertyKeyPolicy\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"property-key-policy\"\n }\n }\n },\n \"type\": \"property-key-policy-entry\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"49237b51-5250-48ac-a6eb-f4accc08a7eb","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-policy-entries?page[cursor]=&page[size]=&filter[propertyKeyPolicy.id]=&filter[propertyKeyPolicy.suppliedId]=","host":["https://platform.vertexvis.com"],"path":["property-key-policy-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":"The `property-key-policy` ID to filter on.","key":"filter[propertyKeyPolicy.id]","value":""},{"description":"The `property-key-policy` supplied ID to filter on.","key":"filter[propertyKeyPolicy.suppliedId]","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"}],"_postman_id":"list-property-key-policy-entries"}],"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":"5bd68621-69a7-4dad-a0a4-d94dc722358c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies?filter[threadId]=&page[cursor]=&page[size]=&include=","host":["https://platform.vertexvis.com"],"path":["replies"],"query":[{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[threadId]","value":""},{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"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":"2c5961ac-92be-48bc-bd6f-f38994954eae","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d53e702a-e97c-4de9-90b9-d117ecb79ee8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"40e1e022-3d1d-44d8-bcc3-1d8f78233672","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"f50a2437-38c5-4a75-9c71-02a314030f5b","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":"7c8a1fca-f0af-40a7-b381-6788e4a4251c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3579856c-fcd9-4fba-b47a-cd81c5b91a1c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"cf1e6e72-e2e0-4236-abc9-70d23c4b8d20","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/replies/:id?include=","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"query":[{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8fcb6787-deb7-46e4-b7aa-5472dbcc97dd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"61d93762-39c5-4644-99b3-dfeb2bfc4932","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e32332e7-a2b9-4986-b458-64e6bbd85053","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"58f0cbf2-15e6-4bc5-a3c9-95ffb033156d","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/replies/:id","host":["https://platform.vertexvis.com"],"path":["replies",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"89678bdb-5e30-4b82-8894-c2161be4b16f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"22acdd57-5da7-4279-be87-b262e39d273c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"04e12026-7f9c-49fe-a70b-68383326c757","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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-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":"ba3e8f65-0dc5-49b2-ab8f-d513bce5effa","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"isDrafting\": \"\",\n \"mentions\": [\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n },\n {\n \"email\": \"\",\n \"fullName\": \"\",\n \"id\": \"\",\n \"type\": \"known-user\",\n \"idpId\": \"\"\n }\n ],\n \"modifiedAt\": \"\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"thread\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"thread\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"reply\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"91f05499-a4ea-4e8a-81fd-6b3b068a6c16","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7619ca6c-acc3-4985-a608-2e3d061d17f2","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7295b757-6086-45f3-84f2-8ae89099c668","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"isDrafting\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"type\": \"scene-reference\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"withSceneViewState\": {\n \"sceneViewId\": \"\",\n \"type\": \"scene-view-id\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n }\n },\n \"withBodyDocument\": {\n \"document\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"type\": \"with-body-document\"\n }\n },\n \"type\": \"reply\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/threads/:id/replies","host":["https://platform.vertexvis.com"],"path":["threads",":id","replies"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"c1c848bf-2965-41a7-8e91-264a789dda2a","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f0335992-7e89-4a47-9a0f-a5083b3fec6c","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":"8e80c9f8-03cc-4c44-87f6-38f6d665f1de","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e28216eb-95e1-4055-922d-ce482af88d77","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ccb6f425-b439-4879-8dfc-47d7b9d932f8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"82a8712d-e926-4ffe-bb18-f04d4f6213e1","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-alterations/:id","host":["https://platform.vertexvis.com"],"path":["scene-alterations",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-alteration` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ca024e8e-667f-421c-bddf-1357e37d84ef","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1cdfca00-f90d-4d04-980e-1ad19334ab6d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"125bd32b-0a85-4e8e-842c-6f8b4539aeda","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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","description":"

Get scene-alterations for a scene-view.

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

(Required) The scene-view ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0d3d917a-86b2-4e01-b52f-7078fc091d45","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 }\n}"},{"id":"9d7963dd-711e-4e5f-8459-54c06fb8dd6c","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4051d69b-8c30-4d6e-a757-b72e36ff823e","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"667a5d9a-bb32-4fde-9605-bffad6d343f8","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-alterations","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-alterations"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"id\",\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":"f278e535-83cb-4f12-8976-2512e1bba27e","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\": \"id\",\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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e194ad5e-138c-4115-9619-a9494f04303f","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\": \"id\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b77485ae-8e26-4285-9f07-b9ba16bd1f4a","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\": \"id\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"405e92d4-e127-4469-8789-31d5299cc436","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\": \"id\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c26bda05-4060-4afc-be1d-414512f823ce","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\": \"id\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"#5fEfCE\",\n \"icon\": \"\",\n \"primaryColor\": \"#fBd65a\"\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":"93996f15-cab2-4504-9d1e-f94e3f539a8a","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\": \"#5fEfCE\",\n \"icon\": \"\",\n \"primaryColor\": \"#fBd65a\"\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\": \"#fa111C\",\n \"icon\": \"\",\n \"primaryColor\": \"#6Fb01d\"\n },\n \"modifiedAt\": \"\",\n \"suppliedId\": \"\"\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":"5c05587b-266d-46dc-93c2-1063dda69dad","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\": \"#5fEfCE\",\n \"icon\": \"\",\n \"primaryColor\": \"#fBd65a\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"ab103fc5-bca7-44e6-bb3d-3c58cfebab39","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":"03bdd340-fd25-4395-88a6-c1cabe05be9e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"05828f4a-1837-4df6-a577-ba6c8e61b57e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"55229de5-067b-4fe3-8076-f418ccf281f4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"#5DEaCd\",\n \"icon\": \"\",\n \"primaryColor\": \"#8fDBe7\"\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":"c5f80e85-3282-43c3-aabd-7a81517f5c2f","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\": \"#5DEaCd\",\n \"icon\": \"\",\n \"primaryColor\": \"#8fDBe7\"\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\": \"#fa111C\",\n \"icon\": \"\",\n \"primaryColor\": \"#6Fb01d\"\n },\n \"modifiedAt\": \"\",\n \"suppliedId\": \"\"\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":"87010cc2-0dc8-4133-acdf-4e75971f0e22","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\": \"#5DEaCd\",\n \"icon\": \"\",\n \"primaryColor\": \"#8fDBe7\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b3df7725-7a29-49ed-86fb-d3b799286efa","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-annotation-sets?page[cursor]=&page[size]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-annotation-sets"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"modifiedAt\": \"\",\n \"name\": \"\",\n \"suppliedId\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3cd1f040-8849-4e1c-8ae9-25a84db3dd77","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"719146e2-3a7b-4ea2-af46-607ae9acbe96","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"eb3c614f-cfa8-4cf3-bf93-ed8f87d1d4f3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"f60ccbd0-d025-4585-9059-22b82f391b71","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"bc02803c-1ee5-4684-be61-fe1f6d357069","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"2770a576-5151-4204-a6ba-c9bcd6d609eb","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":"001b49eb-0a26-477a-af6e-fcbb6420490d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"79c65b71-a7f0-4cde-ab25-585bb87ac66e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"10da2320-eae7-4594-b9ca-de38130d04e2","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b7359100-6ccf-4d71-bf38-48501a8f9e2f","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"848b7d06-b01f-4000-842d-561cc613295d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3d35dc21-a555-4a5a-a3da-56afd04ccb4a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d4c33743-032c-4ee5-9bd2-b733066464ee","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c1854c73-420f-4388-8f83-69bb163471b0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"dacb00a0-7675-46d8-912f-eba003b89473","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 }\n },\n {\n \"attributes\": {\n \"created\": \"\",\n \"endItem\": \"\",\n \"material\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"phantom\": \"\",\n \"selected\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"sceneView\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"de84a630-6299-4737-8e0e-e82e60b0c823","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f92246f9-2a5a-4bb0-8b4f-558acb14e4d0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0fd62f6e-90be-4e32-8724-d5be3d47dee5","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"bb8142f3-651c-4687-8e00-3be1e15c1f6e","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8de2ed9f-c134-4474-9618-119674563b7f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9f25b880-d325-4612-b145-bcb3483ce077","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"bc8a1cc8-c089-44e6-aa2f-8f343e745a44","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3ef46cdc-2406-45af-ba14-98a4bc326c76","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b69be5fa-abf2-4160-8dbc-d916da619708","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"fa4f719f-9c7c-40a2-8e08-e9358eb9e3ea","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2a938c3e-af41-4ebf-99e6-84b32bad7353","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"40fd4fbe-dfe7-46c3-932e-91a660f3674b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"46cfd31d-38a7-4f14-8ecc-678ded297031","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5daeae97-c160-4064-9c90-bfa8717cb107","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":"d7b11064-4404-4c89-9a3d-5233af4c6163","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ee0d45dd-b3d5-4904-96ab-0dd46e74e1a0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1f2ac5a3-d58c-4f14-97f2-901e5781c631","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"23c1c90f-8568-4130-bae5-49eb274da09f","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":"ca7ca98b-2b35-464a-8e59-6793f1d12b70","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4ebba0ae-04ba-4bd2-a039-68cf6d7c8d81","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"99a9915d-2bdc-4c4e-86c1-79632a390df6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"a70aba8e-c1fb-4dda-8af0-af382549ca41","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 \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e8b7f01f-e518-4dbd-a015-6099dd53a143","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"3edfaad2-3397-49b2-881e-55536be53c25","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8889db19-be0e-4802-a981-d8c507b65b5d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 },\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":"ecedd649-5e84-46eb-8ce7-64d3985712f8","name":"Accepted","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"content-location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"52b60944-da1f-436c-8da8-a2c520fc8563","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"762aa279-5cfd-4510-9bf7-fb9b9836b41b","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"b2636d7b-7543-4358-8212-74d7d61f8472","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"081427a6-e4f6-455e-95a0-36e9050ec534","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"materialOverride\": {\n \"value\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-items/:id","host":["https://platform.vertexvis.com"],"path":["scene-items",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","description":"

Get scene-items for a scene.

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

The cursor for the next page of items.

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

The number of items to return.

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

Source ID to filter on.

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

Comma-separated list of supplied IDs to filter on.

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

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

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

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

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

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

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

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

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

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"53820858-c792-424d-97ba-ceb98dd13a79","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"74bb851a-0228-4353-85d2-5639640ab747","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9ce60f3f-e2c4-43fb-8ba8-887a535fe586","name":"Not Found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6ecd61b7-07bb-4af6-8719-1d4c5bc34b62","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-items?page[cursor]=&page[size]=&filter[source]=&filter[suppliedId]=&filter[parent]=&filter[hasChildren]=&filter[hasGeometrySet]=&sort=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-items"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Source ID to filter on.","key":"filter[source]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""},{"description":"Parent ID to filter on. Sending null will return items without a parent.","key":"filter[parent]","value":""},{"description":"Filter scene-items based on whether they are the parent of at least one other scene-item","key":"filter[hasChildren]","value":""},{"description":"Filter scene-items based on whether they have an associated geometry-set.","key":"filter[hasGeometrySet]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 },\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":"06308697-18a3-40cf-a15c-168261ce7dee","name":"Accepted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d5b5cc31-147b-4c0a-bcc1-2aee4dab988b","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8982ec46-bec6-4292-ada3-c1d5fdbfd97d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e7d758c6-d830-4c3c-b65e-1a072956569f","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9652eaec-58be-4d77-a9d4-9bfbc7a0c0e4","name":"Conflict","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cd3e666f-9ea0-477b-b721-1c0f99014347","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"endItem\": \"\",\n \"experimentalSourceMetadataKeys\": [\n \"\",\n \"\"\n ],\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"ordinal\": \"\",\n \"parent\": \"\",\n \"partInstanceSuppliedIdsAsSuppliedIds\": \"\",\n \"phantom\": \"\",\n \"resolutionRule\": \"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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.

\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":"5c6860e4-43de-4a84-8261-b56eea52f060","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"a1a9b7bb-97e1-43e6-ba02-df49ffd2048f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"48f0237f-6497-4c76-bcaa-659467b457bf","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4936ca64-c665-4139-bb1b-8d768fa06ae0","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"86c94fe1-00f1-4a1a-a4dd-69e45522a0e3","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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"26685aae-6268-4229-9246-f6709860ac88","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f0b8b20a-4a3e-41d9-a2af-9950619f6f23","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8fff8b03-7823-4b2e-8f3d-9f27166a7b2a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"7d4b02df-0b62-4c37-bc7c-e3d5ddb5ea80","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 \"key_2\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n },\n \"sceneItem\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"status\": \"\",\n \"error\": {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 \"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 }\n }\n ],\n \"included\": [\n {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n },\n \"key_1\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"6c70a807-faf5-42f7-afca-1e92d6248adc","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"87219851-e34d-4621-9c23-0afbc73f6d1b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"69fab05c-5aac-4b87-a9f1-923587c6d76f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"9dc1ae88-c446-410a-90de-1b0527b1cd3a","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"66ef4d41-043d-419c-85a6-3d2441b2bb79","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"f1ff758f-5290-464f-bada-14c76edd7925","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":"ad7563be-0a2f-465c-8b62-5e889742cfb8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"19ce9a54-ed4c-499a-a2d6-d781d2d75a19","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1ea8ea24-3b24-419b-86b2-ca230a65b484","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"dd4dc99c-298d-4483-ae19-942132843b42","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"2fe3494d-d4a8-43bd-86b2-4fd89bba5454","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a9b2d81b-e4d9-4d90-bbc4-333469451619","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d54a5f2e-d52c-49b3-b2af-c64ee53bed3d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"a0907a21-8736-40bc-9c95-0180ba3711c9","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"noDefaultLights\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scene-views/:id","host":["https://platform.vertexvis.com"],"path":["scene-views",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"06ba3e0d-ed34-4cec-9c56-98358e0db3b6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"721eca72-f6ec-4702-ba69-b1d25241aef1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8a7b16f2-f2c4-4716-b2ef-70148b73da53","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"89c3fae3-a559-4396-8ca2-58538be835ef","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"cb7de6c9-f23e-42d3-ad72-cb835032cbf0","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":"8416431d-519f-45b2-8303-1347f819d361","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"03ab3161-3b06-4279-8c9e-0f10b5bab093","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e9c89caf-3bf8-4a74-92e6-262c4cf5de76","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"95177b50-4b5f-46a9-86e6-d1cd150c98e7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"361a1e7e-00fc-440f-bff2-90ad38a92ebb","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scene-views/:id/scene-items/:itemId?fields[scene-item]=&include=","host":["https://platform.vertexvis.com"],"path":["scene-views",":id","scene-items",":itemId"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.","key":"fields[scene-item]","value":""},{"description":"Comma-separated list of relationships to include in response.","key":"include","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene-view` ID."},{"key":"itemId","value":"","description":"(Required) The `scene-item` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"boundingBox\": {\n \"max\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"min\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"created\": \"\",\n \"endItem\": \"\",\n \"materialOverride\": {\n \"ambient\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"diffuse\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"emissive\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"glossiness\": \"\",\n \"opacity\": \"\",\n \"specular\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"metadata\": {\n \"key_0\": {\n \"type\": \"\",\n \"value\": \"\"\n }\n },\n \"name\": \"\",\n \"phantom\": \"\",\n \"suppliedId\": \"\",\n \"transform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n },\n \"visible\": \"\",\n \"worldTransform\": {\n \"r0\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r1\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r2\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"r3\": {\n \"w\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"parent\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-item\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n }\n },\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\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 }\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":"d1c725d0-f7f6-4b04-a522-d6d579ec573f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0ad75529-f8e6-489f-9fd9-155361f3f083","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7b6252cd-bbd2-4777-92b8-cf20db6b4eb6","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"f18bce52-1d0c-4463-a948-df256fcde243","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 }\n}"},{"id":"16be6e21-748c-4c7f-9ee8-36f99365c126","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1f353ef0-42d0-45eb-811d-36fd40875d2b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"68016b4b-ec4a-4974-aa2c-77a1f8c60c6b","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"expiry\": \"\"\n },\n \"type\": \"\",\n \"relationships\": {\n \"sceneViewState\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view-state\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-views","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-views"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"crossSectioning\": {\n \"planes\": [\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n },\n {\n \"normal\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"offset\": \"\"\n }\n ]\n },\n \"excludePrunedItems\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"\"\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d04e5d4e-ef08-48fd-9c79-76cb2209c2d7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6c0d2516-b43f-4a3f-a496-77a26e325c2c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"045b02bb-e088-437a-98cb-a0330bda4053","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0818dd68-03c7-415f-931a-08d600ee3c0c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"5ff61f2b-5f28-41e7-a13d-438e2cecf369","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"eeab0b7a-cc59-457b-a04a-9c0df13d1414","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":"831d00e4-62d0-482d-abd2-65f18770aea8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"643dd993-fbdc-4b60-ab16-124037147d41","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ddd07d38-5e6d-4811-bf82-3e4ded135e1c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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]=&contains=&eq=>=>e=<=<e=&neq=&contains=&eq=>=>e=<=<e=&neq=&fields[scene]=&key_0=&key_1=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","description":"

Get scenes.

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

The cursor for the next page of items.

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

The number of items to return.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

\n","type":"text/plain"},"key":"neq","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":"contains","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":"eq","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":"gt","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":"gte","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":"lt","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":"lte","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":"neq","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":"

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":"786b41ae-bf57-4f68-b033-2694096c52e0","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]=&contains=&eq=>=>e=<=<e=&neq=&fields[scene]=&key_0=&key_1=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","host":["https://platform.vertexvis.com"],"path":["scenes"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"contains","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"eq","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"gt","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"gte","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"lt","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"lte","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"neq","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":"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 \"key_2\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"24e3f592-103f-4cc3-949a-cccd0380c787","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]=&contains=&eq=>=>e=<=<e=&neq=&fields[scene]=&key_0=&key_1=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","host":["https://platform.vertexvis.com"],"path":["scenes"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"contains","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"eq","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"gt","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"gte","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"lt","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"lte","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"neq","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":"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cc7e4ce7-432a-474e-80cf-e245fcb6549a","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]=&contains=&eq=>=>e=<=<e=&neq=&fields[scene]=&key_0=&key_1=&filter[sceneItems.source.partRevision]=&filter[sceneItems.source.geometrySet]=&filter[sceneItems.source.scene]=","host":["https://platform.vertexvis.com"],"path":["scenes"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"contains","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"eq","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"gt","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"gte","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"lt","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"lte","value":""},{"description":"A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.","key":"neq","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":"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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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":"5be7fb87-1cdc-4829-b249-d22634563a1a","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\",\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"c7745541-e044-4521-a691-72c83af301d5","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ed953eee-f803-49f3-b798-4c10c197a051","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"41bcf4ae-b41b-4c4a-add8-bc4fd34b5edb","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"fedab7d2-6d1a-4f99-894b-ae9615f92ce9","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":"3b95f94d-2667-40c1-99fa-20caf1f4d967","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a644228b-3fd4-4ab5-bf35-d1001ed2f073","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fb52073b-1132-4310-b489-b5512f6ff8eb","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"80a45e49-3ffe-4f26-809f-9feb61ed3b0a","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id?fields[scene]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"query":[{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.","key":"fields[scene]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"9a129f58-e3b0-406b-b0a7-2e3ccfee5895","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7524ba4c-5f79-4452-971e-f829b618209f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"680eaa7f-c07c-45fa-b53d-d92990761700","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/scenes/:id","description":"

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

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

(Required) The scene ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"cef8e232-a197-4cc2-a866-cf86df20f8d4","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"expiresAt\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"modified\": \"\",\n \"name\": \"\",\n \"sceneItemCount\": \"\",\n \"state\": \"\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"3c060886-647f-4a45-b445-fc3b38ea1f3f","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5bd2d715-4e14-41c1-ac6c-24ba36484519","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"7775736f-2b55-432f-9a0d-a848701e0025","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"98bc97bb-036e-40b2-a9d7-ae914e3cf0c4","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"expiry\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"name\": \"\",\n \"state\": \"commit\",\n \"suppliedId\": \"\",\n \"treeEnabled\": \"\",\n \"worldOrientation\": {\n \"front\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id","host":["https://platform.vertexvis.com"],"path":["scenes",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"1c1529ae-32fb-4ef4-bf84-fc37114a64a2","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":"6d342719-f700-4b88-a19b-c65e1b4dc543","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e5f2b44a-f7dc-41d9-a772-fdfd190ff54b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a9bd7300-84c2-420b-b3ad-8de9551d300f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f2611127-c9fe-4b3f-a919-46a524709325","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"18e0592b-aaef-40d4-aeb4-1259f115ea37","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":"26f6c84b-8270-4b32-b298-d09e0f704b17","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"61caaef8-d790-44bb-a902-beace19ceb3a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cf87a774-1b68-4481-8ba5-e28fb670693b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"5d223a19-48a3-46e9-a2ab-9f1d17cb968e","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 }\n}"},{"id":"80c03f93-fcf8-4b6f-9e38-1e12f4999b42","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1add4489-37cf-4114-a7a3-a3066f7fb01d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"eb73b7f0-3957-4ac9-9fbf-6139cbca31c4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"da6ff45d-028a-46ff-8366-c9b45ce19b16","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 }\n}"},{"id":"f735cd63-57b3-4948-a27e-19c069729dae","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"09763660-a9d9-4beb-b702-241e6006b982","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f1e487a0-a8c9-4df8-bf8a-9b44b7e4a7da","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9bb49bb5-f4a8-4512-953d-d31532a96d0e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"d0ed30d9-ae5d-4b24-b4cc-545a4ab33dce","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states?page[cursor]=&page[size]=&fields[scene-view-state]=&filter[id]=&filter[suppliedId]=","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Comma-separated list of fields to return in response. An empty value returns no fields. `thumbnails` is only returned if explicitly requested.","key":"fields[scene-view-state]","value":""},{"description":"Comma-separated list of IDs to filter on.","key":"filter[id]","value":""},{"description":"Comma-separated list of supplied IDs to filter on.","key":"filter[suppliedId]","value":""}],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"canvas\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"canvas\"\n }\n }\n }\n },\n {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\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 }\n}"},{"id":"1bf74a65-fefd-4f45-881b-9c26bbda9dab","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"dce58421-babe-4a14-9012-fd9697dfb2dc","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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-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":"accd14d3-d5fb-45df-9617-234dbcece7e4","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"camera\": {\n \"lookAt\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"up\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"fovY\": \"\",\n \"type\": \"\"\n },\n \"created\": \"\",\n \"featureLines\": {\n \"color\": {\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"width\": \"\"\n },\n \"name\": \"\",\n \"noDefaultLights\": \"\",\n \"suppliedId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"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 }\n}"},{"id":"df8f8530-5cfb-442b-8f96-bd0fe5f819c4","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c09e0469-83f6-41c7-8b0c-1434d7b9382a","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"75b14e8a-e606-48b7-aa91-2e024c0d5b52","name":"Not Found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a94839d8-36c9-4494-bd0a-d6f88caab660","name":"Unsupported Media Type","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"name\": \"\",\n \"suppliedId\": \"\",\n \"withCanvas\": {\n \"document\": {\n \"items\": [\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n },\n {\n \"endPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"fill\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n }\n },\n \"startPosition\": {\n \"x\": \"\",\n \"y\": \"\"\n },\n \"stroke\": {\n \"color\": {\n \"a\": \"\",\n \"b\": \"\",\n \"g\": \"\",\n \"r\": \"\"\n },\n \"thickness\": \"\"\n },\n \"type\": \"line-item-2d\",\n \"endShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n },\n \"startShape\": {\n \"filled\": \"\",\n \"type\": \"arrow-end\",\n \"width\": \"\"\n }\n }\n ],\n \"type\": \"canvas-document-v1\"\n },\n \"type\": \"with-canvas\",\n \"suppliedId\": \"\"\n }\n },\n \"relationships\": {\n \"source\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene-view\"\n }\n }\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/scenes/:id/scene-view-states","host":["https://platform.vertexvis.com"],"path":["scenes",":id","scene-view-states"],"variable":[{"key":"id","value":"","description":"(Required) The `scene` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"ddec8beb-96bb-4bf6-9743-f6f4a5779af7","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"expiry\": \"\"\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n },\n \"type\": \"search-session\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/search-sessions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"58b888c8-fbc9-4028-bddb-519b599c0720","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f401ffec-f347-419c-89b7-a6443ea99e51","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"1ee2d2c6-a9dd-47c3-9bba-a9dc375ee51c","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/search-sessions/:id","host":["https://platform.vertexvis.com"],"path":["search-sessions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `search-session` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"scene\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"scene\"\n }\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"920e7439-4579-457b-b18f-9140ea92ec35","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"15e6b89b-6edc-4d5d-a228-abee8db8cb2e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"11954a8e-43e1-4ad4-a995-46db890d8a0b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"31f6c17b-e405-42e4-bf20-bc74a901a2d7","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 }\n}"},{"id":"bdc4e9cf-e877-4261-86f5-8c6baf3900fa","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1159ff2e-dd62-4ea3-b7e4-3f8af037cb7b","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1b11e84b-2bc9-47d5-b745-c27434e9bb5d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"4618d3a0-1e55-4075-b6b5-1ef9482728bd","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 }\n}"},{"id":"3b5849c9-511c-434d-9939-32835a6d73f8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"ee38ed57-da56-451c-b400-8f0498893fb1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"5c449d98-783e-4dc3-a27f-f0b1b5474e80","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":"753f7ba8-1614-4733-b954-3f85e1070b0d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6c7f1ada-acb2-4732-91c7-e99d53e9efc3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"674ae2d8-5933-49c3-b3b9-36f400b9f375","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"21bbb6d7-052e-41b9-979d-1d2ec5cc728d","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 }\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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"1e497cbc-7b93-4bc6-8a26-237f06c49d77","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4549a7f4-db02-4f92-ac68-4704a1f42f4a","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"37704f01-fce3-4f0e-b3a2-7f4a681ba0ed","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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]=resolved,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":"resolved,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":"73122b9d-b3f0-4106-bcd6-2215d08cf9ae","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]=resolved,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":"resolved,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\": \"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 }\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\": \"resolved\",\n \"type\": \"comment\",\n \"body\": \"\",\n \"bodyDocument\": {\n \"root\": {\n \"content\": [\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n },\n {\n \"content\": [\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n },\n {\n \"text\": \"\",\n \"type\": \"text-node\"\n }\n ],\n \"type\": \"paragraph-node\"\n }\n ],\n \"type\": \"root-node\"\n },\n \"type\": \"text-document-v1\"\n },\n \"editedAt\": \"\",\n \"group\": \"\",\n \"reference\": {\n \"sceneId\": \"\",\n \"thumbnails\": [\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n },\n {\n \"height\": \"\",\n \"uri\": \"\",\n \"width\": \"\"\n }\n ],\n \"type\": \"scene-reference\",\n \"canvasId\": \"\",\n \"position\": {\n \"x\": \"\",\n \"y\": \"\",\n \"z\": \"\"\n },\n \"sceneItemId\": \"\",\n \"sceneViewStateId\": \"\"\n },\n \"replyCount\": \"\",\n \"title\": \"\"\n },\n \"id\": \"\",\n \"relationships\": {\n \"collaborationContext\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"collaboration-context\"\n }\n },\n \"user\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"user\"\n }\n }\n },\n \"type\": \"thread\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"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 \"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 }\n }\n ]\n}"},{"id":"8bd0e2f2-4437-45e3-ae27-3cccc3ef222e","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]=resolved,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":"resolved,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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2b4a3eae-a7cd-42c2-a52c-bbbecf6a9913","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]=resolved,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":"resolved,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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"8bd047e0-8ba0-45f3-b999-250802fe19b0","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":"08a60cb1-1782-4556-aaae-bf4b98fd19c8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"16b06ed2-d19b-4e51-8aab-eb45da689119","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"c178093d-d275-4235-8c48-62fa2b653670","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 }\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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"343d08ca-8864-4ad8-8cc3-2777a182de21","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"826d6c3b-003e-4545-8b12-d7355374c100","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"cde302aa-e177-4ff7-a915-12efc93918d4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"resolved\",\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":"7684fe4a-694a-46d3-9ffa-620a62a18ca7","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\": \"resolved\",\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 }\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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"f6286b46-1283-4460-b2c3-41ae6a0e8aa7","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\": \"resolved\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"fa9058db-effb-4685-a2a7-9e2ee95c938a","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\": \"resolved\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"886d6858-3938-415a-9934-82a0717fff01","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\": \"resolved\",\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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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","description":"

Get a threads users.

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

(Required) The thread ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"efb14e8b-b3ce-4d39-bf51-9776a8463aca","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"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 }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"30127a72-498c-47a6-971d-89e1a033c983","name":"Bad Request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4f9876ad-bd8f-4c9d-96a4-90224974a0ac","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6ec3ae4b-65a1-4ea9-96cb-d6952eddbb44","name":"Unsupported Media Type","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/threads/:id/users","host":["https://platform.vertexvis.com"],"path":["threads",":id","users"],"variable":[{"key":"id","value":"","description":"(Required) The `thread` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"33cbc13d-fb73-4814-add1-0c59b9930954","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"filter\": {\n \"jobId\": [\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/query-translation-jobs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"completed\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"geometrySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n },\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"title\": \"\"\n }\n ]\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"geometrySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ]\n}"},{"id":"e0611a80-158b-48d8-8167-48d31abb751d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d04b205d-3417-4df9-b86a-336e7487efe8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6011f057-0392-458d-b5ba-485000cc9560","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"52558e7e-8ce2-4dc5-9d69-2f29f61aa3c4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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]=&contains=&eq=>=>e=<=<e=&neq=","description":"

Get all current translation jobs in progress.

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

The cursor for the next page of items.

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

The number of items to return.

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

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

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

Status to filter on.

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

The completion date and time to filter on.

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

The completion date and time to filter on.

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

The completion date and time to filter on.

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

The completion date and time to filter on.

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

The completion date and time to filter on.

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

The completion date and time to filter on.

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

The completion date and time to filter on.

\n","type":"text/plain"},"key":"neq","value":""}],"variable":[]}},"response":[{"id":"f47be98d-5e02-4152-8841-8b1a082dce87","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"contains","value":""},{"description":"The completion date and time to filter on.","key":"eq","value":""},{"description":"The completion date and time to filter on.","key":"gt","value":""},{"description":"The completion date and time to filter on.","key":"gte","value":""},{"description":"The completion date and time to filter on.","key":"lt","value":""},{"description":"The completion date and time to filter on.","key":"lte","value":""},{"description":"The completion date and time to filter on.","key":"neq","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 },\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 \"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 \"key_2\": \"\",\n \"key_3\": \"\"\n },\n \"source\": {\n \"parameter\": \"\",\n \"pointer\": \"\"\n },\n \"status\": \"\",\n \"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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"71924846-d3c5-4a78-b20f-12699d64eb1b","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"contains","value":""},{"description":"The completion date and time to filter on.","key":"eq","value":""},{"description":"The completion date and time to filter on.","key":"gt","value":""},{"description":"The completion date and time to filter on.","key":"gte","value":""},{"description":"The completion date and time to filter on.","key":"lt","value":""},{"description":"The completion date and time to filter on.","key":"lte","value":""},{"description":"The completion date and time to filter on.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9b1f0e73-b024-463b-b6a5-546f734cae30","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"contains","value":""},{"description":"The completion date and time to filter on.","key":"eq","value":""},{"description":"The completion date and time to filter on.","key":"gt","value":""},{"description":"The completion date and time to filter on.","key":"gte","value":""},{"description":"The completion date and time to filter on.","key":"lt","value":""},{"description":"The completion date and time to filter on.","key":"lte","value":""},{"description":"The completion date and time to filter on.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1122d2a4-fdbd-4f8a-9507-99c6957cfd4a","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]=&contains=&eq=>=>e=<=<e=&neq=","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"A sort to apply to the collection. A \"minus\" prefixed before the field name is used to specify descending sort order.","key":"sort","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""},{"description":"The completion date and time to filter on.","key":"contains","value":""},{"description":"The completion date and time to filter on.","key":"eq","value":""},{"description":"The completion date and time to filter on.","key":"gt","value":""},{"description":"The completion date and time to filter on.","key":"gte","value":""},{"description":"The completion date and time to filter on.","key":"lt","value":""},{"description":"The completion date and time to filter on.","key":"lte","value":""},{"description":"The completion date and time to filter on.","key":"neq","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"d9893d6b-d4fa-45e3-a71c-85c2a9c0fb0d","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 },\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 \"key_1\": {\n \"href\": \"\"\n }\n },\n \"relationships\": {\n \"geometrySet\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"geometry-set\"\n }\n },\n \"partRendition\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-rendition\"\n }\n },\n \"partRevision\": {\n \"data\": {\n \"id\": \"\",\n \"type\": \"part-revision\"\n }\n }\n }\n },\n \"included\": [\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n {\n \"attributes\": {\n \"created\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"6102fc5b-9bf8-4382-9523-6434269870c1","name":"Moved Permanently","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translation-jobs/:id","host":["https://platform.vertexvis.com"],"path":["queued-translation-jobs",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `queued-translation` ID."}]}},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"43e8c8e2-6975-4bde-84d0-5aa07e588668","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c3deaa5b-e3e3-490e-9b01-ebcbe7a00e71","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f3bbcbde-3134-4ab1-b5f2-a4856d8ab0a8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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 - Get queued-translations.

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

The cursor for the next page of items.

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

The number of items to return.

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

Status to filter on.

\n","type":"text/plain"},"key":"filter[status]","value":""}],"variable":[]}},"response":[{"id":"e3384afa-e496-4874-9c5c-c44ff36966dc","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/queued-translations?page[cursor]=&page[size]=&filter[status]=","host":["https://platform.vertexvis.com"],"path":["queued-translations"],"query":[{"description":"The cursor for the next page of items.","key":"page[cursor]","value":""},{"description":"The number of items to return.","key":"page[size]","value":""},{"description":"Status to filter on.","key":"filter[status]","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"\",\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n },\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 }\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 },\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 \"code\": \"\",\n \"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 \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d921b9c0-1de5-47cd-b76b-824df6268f62","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":"a77dd1bc-a70b-4cbd-8b9a-2c7f45e81f09","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"14b35342-6741-4968-8c6c-349ed94275f3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c343a1af-3203-45e7-9a39-4e4f9b53b8bd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"d525bf06-541d-4a14-9f36-14536dcae98e","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 },\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 }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7f3d1218-c91f-497b-9f90-2f5b5a5e84a3","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":"db8a460d-e251-426d-bc29-542a7fdfc7c8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"295ba132-71c3-465f-aa1a-c0e64c71c830","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"1068ae17-503b-4d0a-9782-567a30820aba","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"cdbf52e4-a830-425e-b6aa-fb604dd05ea7","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":"36e928a9-6fff-4bef-b5ea-0147d54e6af2","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"6ad0192d-aa9a-4de2-90dc-655f10527dc7","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"e1bd813b-30fe-4f56-9d59-a1cdeb8c8736","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b21d644e-9025-4364-81de-6f55dcefa259","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":"ca95dfc5-d8d2-493f-bd88-54a32f8b1704","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0154592d-8b4d-4e34-b0e6-8c5a41e0df51","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0db669ad-6549-4ec4-a8ae-6863de5c0ba1","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"a8d5004f-1b0f-438b-9233-28164025249f","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 }\n },\n {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"dc1be32c-efac-456f-9a69-bc8e3512ea53","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"01bac688-dcd1-4ce2-b69f-8d95eb2db3aa","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"aba91ff2-6171-490e-8797-0eb006a13314","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"6b2762d8-a0db-47c1-a090-728422d04576","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"type\": \"user\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"ccd48857-e849-46d6-8a38-44a5496d9fbd","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"547fa643-8e07-411f-b3cd-45a3a82c5b57","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8f0882f6-3b68-4aae-9da7-3858348cd546","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"61308fed-9501-4411-a5df-9f4a9d5cc77e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/users/:id","host":["https://platform.vertexvis.com"],"path":["users",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"createdAt\": \"\",\n \"email\": \"\",\n \"fullName\": \"\",\n \"idpId\": \"\"\n },\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"8cba2d11-67f2-443f-a85c-c841d4950c1f","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"adf438b1-88ca-4a86-a83a-20b152c7de84","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5f09729e-a5c2-4607-9644-75e69995a9b8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b070744c-5f8b-4552-9b51-0a7badd3f594","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 \"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":"ca218122-8292-414d-9cd5-50b6dcef3d7c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"165c0437-03b3-45b0-b1ce-a3e0ecfbd117","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"8ac068c6-0062-4359-a3ed-45a9b13a6001","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"b3c4bb0f-175b-4502-a7fa-4a2ded96e180","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 \"key_1\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"585309ed-18c9-4de6-bca2-5c8a118109b2","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"81efdbd4-9c98-4cda-babe-f5913362063d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2a3e2fce-84c3-41f0-8728-76b40571a862","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"99219c8f-187e-442c-a74c-abcebd3a3f60","name":"No Content","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/user-groups/:id","host":["https://platform.vertexvis.com"],"path":["user-groups",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `user-group` ID."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":null},{"id":"6ea97f0e-bea6-4edd-8d26-77f3b58d80db","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"d4e6e024-a759-40b3-ae7a-73ec286fa49e","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"2b716c67-7a78-40f0-a108-6a13d67c1609","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"a3bd7e60-594e-417c-bd05-dc6f4d2bc7a7","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":"d6df070e-316b-42df-b258-38c4aab97d01","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"0209c59b-e25f-42cf-bf85-a69fd1238ee5","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9b8704c1-e22b-4352-ac15-4327150cdc1c","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"ff673ac4-e797-4bf3-973a-76c0200f08a9","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\": \"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 \"key_2\": {\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 \"key_1\": {\n \"href\": \"\"\n }\n }\n }\n ],\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n },\n \"key_3\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"d9508035-b30d-4c28-8f12-8774920b736d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"4caaa9f5-fb91-4d45-a476-4f2890741cf3","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"2bd74072-53d0-472d-b32d-242c4f87898d","name":"Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"disabled":false,"description":{"content":"","type":"text/plain"},"key":"location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"5c42b34f-72da-443a-a919-d0fcea89ff56","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"a1377480-c7ef-4be9-9fb0-a0126c648f1d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"c2c3df8d-0c8d-4190-b728-20e55f853776","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":"05053ee3-2298-465a-8826-932ef512fd80","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"37d127ee-f526-4f61-9fa3-df554ce39d99","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"639a9e4d-e911-4a88-8ba5-3e4ff64ad0d4","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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":"3a428670-09d2-4959-9063-c71acd98d3ac","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"e121d7ef-2b2a-47e3-918f-eac396201dff","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"c6243f2d-5093-4f89-84f4-e3e92b0aab1d","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"f2481086-5d75-48fd-9bb7-5a06784726e8","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 \"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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://platform.vertexvis.com/webhook-subscriptions/:id","description":"

Update a webhook-subscription.

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

(Required) The webhook-subscription ID.

\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"6cfd4873-51ee-422a-92bd-b4a669949e9a","name":"OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"attributes\": {\n \"created\": \"\",\n \"status\": \"paused\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\",\n \"secret\": \"\"\n },\n \"id\": \"\",\n \"type\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n },\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n },\n \"key_2\": {\n \"href\": \"\"\n }\n }\n}"},{"id":"7fe7757d-6ce9-4842-96e7-2839f0aeb538","name":"Bad Request","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"30558e11-90fa-4006-93bb-9ba3a43d8564","name":"Unauthorized","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"9b65fa23-3ce5-4410-9b13-7f23d8587cfb","name":"Not Found","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\n \"meta\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n}"},{"id":"5e3ec670-0ea4-45fc-a27f-eab8737b025d","name":"Unsupported Media Type","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"attributes\": {\n \"status\": \"active\",\n \"topics\": [\n \"\",\n \"\"\n ],\n \"url\": \"\"\n },\n \"type\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"https://platform.vertexvis.com/webhook-subscriptions/:id","host":["https://platform.vertexvis.com"],"path":["webhook-subscriptions",":id"],"variable":[{"key":"id","value":"","description":"(Required) The `webhook-subscription` ID."}]}},"status":"Unsupported Media Type","code":415,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/vnd.api+json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"code\": \"\",\n \"detail\": \"\",\n \"id\": \"\",\n \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\n \"href\": \"\"\n }\n },\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 },\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 \"links\": {\n \"key_0\": {\n \"href\": \"\"\n },\n \"key_1\": {\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"}]}