Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PLAT-4042] Document CONNECT_WORKSPACE_URN option #72

Merged
merged 4 commits into from
Apr 16, 2024
Merged

[PLAT-4042] Document CONNECT_WORKSPACE_URN option #72

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d714c81
CONNECT_WORKSPACE_URN
amvertex Apr 11, 2024
18243b2
CONNECT_WORKSPACE_URN
amvertex Apr 11, 2024
01c060d
Workspace URNs
amvertex Apr 12, 2024
2e67f4c
Update render-static-scenes.mdx
amvertex Apr 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/guides/render-static-scenes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,17 @@ curl --location --request POST \
</TabItem>
</Tabs>

:::tip
Scenes that are created or updated with the metadata key/value pair `"CONNECT_WORKSPACE_URN": "{YOUR_URN}"` will be added to the corresponding Connect workspace. This information can be added to the attributes section of your requests:
```
"attributes": {
"metadata": {
"CONNECT_WORKSPACE_URN": "{YOUR_URN}"
}
}
```
:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of having a separate section for this on the Import Data page? Seems more related to the importing of your data vs rendering. Also guessing that the import data guide will expand with details about integrating with your PDM.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fair. How about this?


Now that the scene resource exists, `POST` to the [createSceneItem](https://docs.vertexvis.com/#d597f539-3785-4c83-a645-fdf3a9a90521) API. This API is asynchronous, returning the status of a queued scene item. See the [Transformation matrices](./transformation-matrices.mdx) reference for an explanation of the `transform` property.

<Tabs
Expand Down
Loading