=== Helix Sync Clients [[post_helix_sync_v1_project_clients_device]] ==== `POST /helix-sync/v1/[project]/clients/device` Creates a new client workspace for use by helix sync for a particular device. This method can have multiple implementations. To use a "Helix Versioning Engine Project" as defined in <<appendix_hve_project_json>>, you will need to ensure the `HVE_PROJECT_PATH` is set. This can be set on a request, or on the system as a whole. ===== Request URL Path Parameters [cols="2*", options="header"] |=== | Parameter | Description | `project` | The project ID, see <<appendix_project_json>> |=== ===== Request Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Authorization` | See <<authentication>> | `Accept` | `application/json` | `Content-Type` | `application/json` | `X-Perforce-Helix_Web_Services-*` | See <<per_request_configuration>> |=== ===== Request Body JSON Requires a JSON object with the following parameters: [cols="2*", options="header"] |=== | Property | Description | `project` | The project ID, see <<appendix_project_json>> | `device` | A unique ID for the device in use. | `root` | The directory path on the user's machine to use. |=== ===== Response Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Content-Type` | `application/json` |=== ===== Response Body JSON Returns a JSON object with a `client` property, indicating the client name to use. [[delete_helix_sync_v1_project_clients_device_device]] ==== `DELETE /helix-sync/v1/[project]/clients/device/[device]` Removes the client workspace associated for the project associated with a particular device. ===== Request URL Path Parameters [cols="2*", options="header"] |=== | Parameter | Description | `project` | The project ID, see <<appendix_project_json>> | `device` | The device ID associated with the client, see <<appendix_project_json>> |=== ===== Request Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Authorization` | See <<authentication>> | `Accept` | `application/json` | `Content-Type` | `application/json` | `X-Perforce-Helix_Web_Services-*` | See <<per_request_configuration>> |=== ===== Response Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Content-Type` | `application/json` |=== ===== Response Body JSON See <<error_responses>> for the format of failures. [[post_helix_sync_v1_project_clients_shelf]] ==== `POST /helix-sync/v1/[project]/clients/shelf` Creates a new client workspace for use by helix sync for the main shelf. This method can have multiple implementations. To use a "Helix Versioning Engine Project" as defined in <<appendix_hve_project_json>>, you will need to ensure the `HVE_PROJECT_PATH` is set. This can be set on a request, or on the system as a whole. ===== Request URL Path Parameters [cols="2*", options="header"] |=== | Parameter | Description | `project` | The project ID, see <<appendix_project_json>> |=== ===== Request Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Authorization` | See <<authentication>> | `Accept` | `application/json` | `Content-Type` | `application/json` | `X-Perforce-Helix_Web_Services-*` | See <<per_request_configuration>> |=== ===== Request Body JSON Requires a JSON object with the following parameters: [cols="2*", options="header"] |=== | Property | Description | `project` | The project ID, see <<appendix_project_json>> | `root` | The directory path on the user's machine to use. |=== ===== Response Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Content-Type` | `application/json` |=== ===== Response Body JSON Returns a JSON object with a `client` property, indicating the client name to use. [[delete_helix_sync_v1_project_clients_shelf]] ==== `DELETE /helix-sync/v1/[project]/clients/shelf` Removes the client workspace associated for the project for the purposes of shelving. ===== Request URL Path Parameters [cols="2*", options="header"] |=== | Parameter | Description | `project` | The project ID, see <<appendix_project_json>> |=== ===== Request Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Authorization` | See <<authentication>> | `Accept` | `application/json` | `Content-Type` | `application/json` | `X-Perforce-Helix_Web_Services-*` | See <<per_request_configuration>> |=== ===== Response Headers [cols="2*", options="header"] |=== | Header Name | Notes | `Content-Type` | `application/json` |=== ===== Response Body JSON See <<error_responses>> for the format of failures.
| # | Change | User | Description | Committed | |
|---|---|---|---|---|---|
| #3 | 16114 | Doug Scheirer | Merge from main | ||
| #2 | 15845 | Doug Scheirer | Integ from main | ||
| #1 | 15688 | Doug Scheirer |
Populate -o //guest/perforce_software/helix-web-services/... //guest/doug_scheirer/helix-web-services/.... |
||
| //guest/perforce_software/helix-web-services/main/source/doc/helix_sync/clients.asc | |||||
| #1 | 15622 | tjuricek |
Move source code to 'source/' subdirectory of branch. build/ will remain where it is. |
||
| //guest/perforce_software/helix-web-services/main/doc/helix_sync/clients.asc | |||||
| #3 | 15479 | tjuricek | Added a basic "HVE project" implementation for creating clients. | ||
| #2 | 15435 | tjuricek |
Add proposed HTTP methods for Helix Sync. It's a little unclear to me why you would need a local root directory to create the shared shelving changelist for a particular project (and user). So I didn't add that. |
||
| #1 | 15242 | tjuricek | Add Helix Sync stubs and documentation | ||