b_hve_project_json.asc #1

[[appendix_hve_project_json]]
=== Appendix B: Helix Versioning Engine Project JSON

Returns projects that are stored in a single Helix Versioning Engine server.

If the `HVE_PROJECT_PATH` setting is specified, this will return all directories under that path as projects.
The project `id` is encoded to be a specific part of a URL.
It is the application's responsibility to deal with any reconfiguration of the `HVE_PROJECT_PATH` setting.
The project `id` is only valid for the same setting.

The project `name` is also the name of the directory, just not URL-safe.

The `server` property will include the `HVE_PROJECT_PATH` setting as the URL path.

The content type of this JSON is `application/vnd.perforce.project.hve.v1+json`.
The simple string ID is `hve`.

==== JSON Structure

[cols="3*", options="header"]
|===
| Property
| Required
| Description

| `depotPath`
| Yes
| The absolute depot path to the folder on the server.
|===