Copy a file

To copy a file, send a request with a id path parameter for the file to copy that defines the location and name of the copy.

Filesets cannot be copied.

To copy a file:

• API CALL:

POST {base URL}/api/files/{id}/copy

—OR—

POST {base URL}/api/files/copy?path={file_path}

• HEADERS:

  • Accept: application/json

  Note: This may be automatically added by your development tool. Postman and curl add this header to all requests.

  • Content-Type: application/json
  • Authorization: Bearer {bearer token}Include Trimble Identity OAuth Bearer token for your application.

• BODY: Base your body on the Example Request code sample below. The path attribute is required.

Example request:

{
      "file": {
          "path": "777acac5541c9a0f9be4d6517f00b8b8:/user_files/file_copy.jpg",
          "restricted_access": true,
          "regions": ["aws-us1"]
      }
  }

Example response:

{
      "file": {
          "created_at": "2019-06-28T15:57:07.229Z",
          "fileset": false,
          "id": "d555acd6dd-55ac-55ac-923e-b1709706e7fe",
          "malware_status": "UNSCANNED",
          "md5": "9cdd67b8be483ff6e0763178723ad125",
          "metadata": {},
          "multipart": false,
          "path": "3a92b2e68dea48b68eaf16156c0701b2:/copied_file.txt",
          "region_preferences": ["us1"],
          "regions": [],
          "restricted_access": true,
          "size": 677828,
          "status": "FINALIZING",
          "version": 1
      }
  }

Until the copied file successfully gets replicated to all of the regions specified (or their values copied from src), two things happen:

The copied file will show a FINALIZING status.

A lock will be placed onto the source and the copied file. This lock will prevent both the files from being deleted until the copy operation succeeds including the internal replication.

After the copy operation is complete, the file status value will be AVAILABLE.

Reference Materials

Data Ocean API definition