Some Designer API endpoints take system paths as fields in their requests. Designer supports the use of path symbols and path variables in place of absolute file system locations. These placeholders are resolved to the exact paths on disk at request time.
Path symbols and variables are not supported by all Designer API endpoints.
Only the endpoints listed below perform path resolution. Using symbols in unsupported endpoints will result in an error or undefined behaviour.
To use a path symbol, simply place it in curly braces within your path string. For example, take a look at this request JSON:
{ "path": "{projects}/myproject" }
{projects} will be resolved to your d3 Projects directory, e.g. C:/Users/Disguise/Documents/d3 Projects.
These symbols will be resolved to the configured location of the directory at the time of request. Changing for example the location of your d3 Projects will mean any further use of path symbols will resolve to that location.
| Symbol | Resolves To |
|---|---|
| projects | d3 Projects Directory |
| rs-assets | RenderStream Projects Directory |
| rs-engines | RenderStream Engines Directory |
We are also able to pass certain variables to path fields. There are given variables for which Designer allows you to provide values. What this looks like is a key/value pair, also placed inside curly braces. For example:
{ "path" : "{project:my-project}" }
This will resolve to a directory in your d3 Projects folder called my-project.
| Variable | Description | Resolves To |
|---|---|---|
| project | The name of a project in your projects folder | Absolute path to that project’s directory |