tc_shares
List, get, create, update, and delete shares to share files and views with external users in Trimble Connect.
Instructions
Trimble Connect Shares (share files/views with external users). Select the endpoint with the "action" parameter. Path placeholders {projectId}/{id}/{subId}/{extraId}/{version} are filled from the matching input parameters. Actions:
list: GET /shares — query: {projectId}
get: GET /shares/{id} — id=shareId
get_by_token: GET /shares/token/{id} — id=share token (stoken)
create: POST /shares — body: ShareObjectRequest
update: PATCH /shares/{id} — id=shareId, body: fields to update
delete: DELETE /shares/{id} — id=shareId
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Primary resource ID — required when the action path contains {id} | |
| body | No | JSON request body for POST/PUT/PATCH (and some DELETE) actions | |
| query | No | Query parameters as key-value pairs | |
| subId | No | Secondary resource ID — required when the action path contains {subId} | |
| action | Yes | Endpoint to call (see tool description) | |
| region | Yes | Trimble Connect region: us (North America), eu (Europe), ap (Asia-Pacific), ap-au (Australia) | |
| extraId | No | Tertiary resource ID — required when the action path contains {extraId} | |
| version | No | Version number — required when the action path contains {version} | |
| projectId | No | Project ID — required when the action path contains {projectId} | |
| bcfVersion | No | BCF API version for BCF actions (default 2.1) |