Link support files

To create a link between a parent file and a support file, the parentId attribute must be set to the ID of the parent file, and the parentType attribute must be set to FILE.

Support files can be linked during upload operation or after the upload operation.

• On upload - Upload operation supports linking a support file to a parent file.
• After upload - Use the PATCH file API or the POST link API.

Limitations

• A parent file can have a maximum of 10 support file links.

Prerequisites

• A main file should be created. To know more about create a file refer here

Link on upload

1. Create a new support file upload

Request

POST {baseUrl}/spaces/{spaceId}/uploads

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • name - Name of file
  • parentId - Parent id for the file where it needs to be created
  • parentType - Should be FILE for support files
  • supportFileKey - Key to link the support file to the parent file
  • parentMajorVersion - Major version of the parent file to link the support file to a specific version of the parent file

Example request body:

       {
           "name" : "processed.skp",
           "parentId" : "e492c129-141d-4679-b0a7-829580679b6a",
           "parentType" : "FILE",
           "supportFileKey" : "SKP",
           "addToLinks" : true,
           "parentMajorVersion" : 2
       }

Response

After the upload operation is completed, the JSON response includes the id value for the file and URLs for file upload.

Example response:

{
       "createdAt": "2024-06-24T09:31:19Z",
       "createdByTrn": "trn:tid:application:fae7a6aa-cf9b-42ad-945b-a89d1c1ec580",
       "fileInputUploadDetails": {
           "fileId": "e492c129-141d-4679-b0a7-829580679b6a",
           "fileset": false,
           "metadata": {
               "testkey": "testvalue"
           },
           "multipart": false,
           "name": "Hettingerstad",
           "parentId": "24f92ed9-74be-4556-bfb3-ab037fdb08a1",
           "path": "/test125/Hettingerstad",
           "restrictedAccess": false,
           "spaceId": "cbbf270b-a8cb-450b-8192-495cf252d921",
           "upload": {
               "type": "SINGLEPART",
               "url": "https://us-aws-wo.dev.fileservice.trimblecloud.com/fs_s/e492c129-141d-4679-b0a7-829580679b6a.a257f7d4-5fd8-4300-8d9a-1b611771be4b?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly91cy1hd3Mtd28uZGV2LmZpbGVzZXJ2aWNlLnRyaW1ibGVjbG91ZC5jb20vZnNfcy9lNDkyYzEyOS0xNDFkLTQ2NzktYjBhNy04Mjk1ODA2NzliNmEuYTI1N2Y3ZDQtNWZkOC00MzAwLThkOWEtMWI2MTE3NzFiZTRiIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzE5MjI1MDc5fX19XX0_&Signature=PGejC2lqBmwoBieqdcyE3xUNx6XQ9tb1GJxHCBGmdknA~5KYj11W37m6JebYBJNjfY~d2WFNzLuNZKLLudCM57CmM3pIWaGBinDN3Msb5dz3gmbBVQeGw1pwDQZFV66fdgCmcA6iYzpNeAaqmEZt-AnBqpQbBTA8IC~Y2OlxSnRMwFM5v4iD4e2Uifxj0zymVTEaKKoZhNLVi3x5EqmCMZrCdG3AQncwdqbqoNlRdysNPg0m01jGRNBUdWIDg6oK-GlS5WWdj3NC0BTwxWe-moGFT9YXiAZn3ZTOUpwSIbmDy~uLjAmUVSmdilpho37Pko9LO5WpbBe2ixUnc1a4FQ__&Key-Pair-Id=APKAI6JAFOBXQEFCLCSQ"
           },
           "parentType" : "FILE"
       },
       "id": "a257f7d4-5fd8-4300-8d9a-1b611771be4b",
       "updatedAt": "2024-06-24T09:31:19Z",
       "updatedByTrn": "trn:tid:application:fae7a6aa-cf9b-42ad-945b-a89d1c1ec580"
   }

Once the file content is uploaded as mentioned here, the support file will be linked to the parent file.

Link after upload

1. Create a new support file upload

Request

POST {baseUrl}/spaces/{spaceId}/uploads

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • name - Name of file
  • parentId - Parent id for the file where it needs to be created
  • parentType - FILE or FOLDER. But for the support file upload it should be FILE
  • supportFileKey - Key to link the support file to the parent file
  • parentMajorVersion - Major version of the parent file to link the support file to a specific version of the parent file

Example request body:

       {
           "name" : "processed.skp",
           "parentId" : "e492c129-141d-4679-b0a7-829580679b6a",
           "parentType" : "FILE",
           "addToLinks" : false
       }

Response

After the upload operation is completed, the JSON response includes the id value for the file and URLs for file upload.

Example response:

{
       "createdAt": "2024-06-24T09:31:19Z",
       "createdByTrn": "trn:tid:application:fae7a6aa-cf9b-42ad-945b-a89d1c1ec580",
       "fileInputUploadDetails": {
           "fileId": "e492c129-141d-4679-b0a7-829580679b6a",
           "fileset": false,
           "metadata": {
               "testkey": "testvalue"
           },
           "multipart": false,
           "name": "Hettingerstad",
           "parentId": "24f92ed9-74be-4556-bfb3-ab037fdb08a1",
           "path": "/test125/Hettingerstad",
           "restrictedAccess": false,
           "spaceId": "cbbf270b-a8cb-450b-8192-495cf252d921",
           "upload": {
               "type": "SINGLEPART",
               "url": "https://us-aws-wo.dev.fileservice.trimblecloud.com/fs_s/e492c129-141d-4679-b0a7-829580679b6a.a257f7d4-5fd8-4300-8d9a-1b611771be4b?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly91cy1hd3Mtd28uZGV2LmZpbGVzZXJ2aWNlLnRyaW1ibGVjbG91ZC5jb20vZnNfcy9lNDkyYzEyOS0xNDFkLTQ2NzktYjBhNy04Mjk1ODA2NzliNmEuYTI1N2Y3ZDQtNWZkOC00MzAwLThkOWEtMWI2MTE3NzFiZTRiIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzE5MjI1MDc5fX19XX0_&Signature=PGejC2lqBmwoBieqdcyE3xUNx6XQ9tb1GJxHCBGmdknA~5KYj11W37m6JebYBJNjfY~d2WFNzLuNZKLLudCM57CmM3pIWaGBinDN3Msb5dz3gmbBVQeGw1pwDQZFV66fdgCmcA6iYzpNeAaqmEZt-AnBqpQbBTA8IC~Y2OlxSnRMwFM5v4iD4e2Uifxj0zymVTEaKKoZhNLVi3x5EqmCMZrCdG3AQncwdqbqoNlRdysNPg0m01jGRNBUdWIDg6oK-GlS5WWdj3NC0BTwxWe-moGFT9YXiAZn3ZTOUpwSIbmDy~uLjAmUVSmdilpho37Pko9LO5WpbBe2ixUnc1a4FQ__&Key-Pair-Id=APKAI6JAFOBXQEFCLCSQ"
           },
           "parentType" : "FILE"
       },
       "id": "a257f7d4-5fd8-4300-8d9a-1b611771be4b",
       "updatedAt": "2024-06-24T09:31:19Z",
       "updatedByTrn": "trn:tid:application:fae7a6aa-cf9b-42ad-945b-a89d1c1ec580"
   }

Once the file content is uploaded as mentioned here, get the file id.

2. Use the PATCH file API

Limitation: Only the parent file’s latest version can be linked using this API

Request

PATCH {baseUrl}/spaces/{spaceId}/files/{fileId}

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • links - Links object which contains the support file key, support file id and support file version
  • links.<key> - The support file key
  • links.<key>.id - The id of the support file
  • links.<key>.version - The version of the support file. If not provided, the latest version will be linked

Example request body:

       {
           "links" : {
               "SKP" : {
                   "id" : "a257f7d4-5fd8-4300-8d9a-1b611771be4b",
                   "version" : "1.1"
               }
           }
       }

3. Use the POST link API

Parent file’s specific version can be linked using this API. Use the <major_version>.* format as the version ID because support files and links operate only on the main content version.

Request

POST {baseUrl}/spaces/{spaceId}/files/{fileId}/versions/{versionId}/link

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • links - Links object which contains the support file key, support file id and support file version
  • links.<key> - The support file key
  • links.<key>.id - The id of the support file
  • links.<key>.version - The version of the support file. If not provided, the latest version will be linked

Example request body:

       {
           "links" : {
               "SKP" : {
                   "id" : "a257f7d4-5fd8-4300-8d9a-1b611771be4b",
                   "version" : "1.1"
               }
           }
       }

To know more about the upload file API refer here.