Create restricted file

A file with restricted access would be signed each time the file is accessed and only available based on the URL Expiration. The urlDuration is set to 5 minutes by default. The urlDuration can be set to a maximum of 7 days. However, if restrictedAccess is set to false, the file becomes publicly available. The download URL will not be expired for public files. By default, the restrictedAccess is set to true.

Prerequisites

• A space should be created. To know more about creating a space, refer here

1. Create a new upload fileset object

Request

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

• HEADER:

  • Authorization: Bearer {tid token}

• BODY:

  • name - Name of the file
  • parentId - Parent id for the file where it needs to be created
  • restrictedAccess - Boolean value to indicate if the file needs to be created as a restricted file

Example request body:

       {
           "name" : "test",
           "parentId" : "e492c129-141d-4679-b0a7-829580679b6a",
           "restrictedAccess" : true
       }

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:<applicationId>",
       "fileInputUploadDetails": {
           "acl": {
               "contentManager": [
                   "trn:tid:application:<applicationId>"
               ]
           },
           "fileId": "e492c129-141d-4679-b0a7-829580679b6a",
           "fileset": true,
           "metadata": {
               "testkey": "testvalue"
           },
           "multipart": false,
           "name": "Hettingerstad",
           "parentId": "24f92ed9-74be-4556-bfb3-ab037fdb08a1",
           "path": "/test125/Hettingerstad",
           "restrictedAccess": true,
           "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"
           }
       },
       "id": "a257f7d4-5fd8-4300-8d9a-1b611771be4b",
       "updatedAt": "2024-06-24T09:31:19Z",
       "updatedByTrn": "trn:tid:application:<applicationId>"
   }

2. Upload file content

Perform a PUT operation with the upload URL from the POST call in the previous step. Use the upload URL provided in the response to upload compressed fileset (.zip, .tar, or .tar.gz).

Request

PUT {UPLOAD URL}

• BODY: {File Content}

3. Validate the upload

Run a GET upload API call to check the job status. The value should be COMPLETED.

Request

GET {baseUrl}/spaces/{spaceId}/uploads/{uploadId}

• HEADER:

  • Authorization: Bearer {tid token}

Response

Example response:

{
"id": "e28982f5-ebd8-4a76-97f4-0783fc143f30",
"fileInputUploadDetails": {
    "fileId": "e28982f5-ebd8-4a76-97f4-0783fc143f30",
    "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
    "name": "FileName.ext",
    "acl": {
    "contentManager": [
        "trn:tid:user:<userId>",
        "trn:tid:user:<userId>"
    ],
    "contentContributor": [
        "trn:tid:application:<applicationId>",
        "trn:tid:application:<applicationId>"
    ],
    "contentViewer": [
        "trn:tid:device:<deviceId>"
    ]
    },
    "upload": {
    "url": "https://example.com/upload/12345678-90ab-cdef-1234-567890abcdef.1",
    "type": "SINGLEPART"
    },
    "parentId": "e28982f5-ebd8-4a76-97f4-0783fc143f30",
    "path": "testA/testB/FileName.ext",
    "fileset": true,
    "restrictedAccess": true,
    "expiresAt": "2024-01-01T12:25:00.000Z",
    "metadata": {
    "language": "Suomi"
    },
    "multipart": false,
    "responseHeaders": {
    "response-content-type": "image/jpeg",
    "response-content-disposition": "inline",
    "response-cache-control": "max-age=3000"
    },
    "applicationId": "<applicationId>"
},
"createdAt": "2023-05-30T10:30:00Z",
"createdByTrn": "trn:tid:application:<applicationId>",
"updatedAt": "2023-05-30T10:30:00Z",
"updatedByTrn": "trn:tid:application:<applicationId>",
}

To know more about the Create restricted file API refer here.