Last modified by Dennis Segebarth on 2024/10/02 18:38
From version 1.4
edited by Susan Evans
on 2023/07/10 22:18
Change comment: (Autosaved)
To version 1.5
edited by Susan Evans
on 2023/07/10 22:20
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -453,8 +453,68 @@
453 453  * When uploading file to the Project Core, the user must have access to the Core (Project Contributors cannot upload files/folders to the Project Core).
454 454  )))
455 455  
456 +{{code language="none"}}
457 +$ pilotcli file upload --help
458 +Usage: pilotcli file upload [OPTIONS] [PATHS]...
456 456  
460 + Upload files/folders to a given Project path.
457 457  
462 +Options:
463 + -p, --project-path TEXT Project folder path starting from Project code.
464 + (i.e., indoctestproject/user/folder) [required]
465 +
466 + -a, --attribute TEXT File Attribute Template used for annotating files
467 + during upload.
468 +
469 + -t, --tag TEXT Add a tag to the file. This option could be used
470 + multiple times for adding multiple tags.
471 +
472 + -z, --zone TEXT Target Zone (i.e., core/greenroom) [default:
473 + greenroom] [default: greenroom]
474 +
475 + -m, --upload-message TEXT The message used to comment on the purpose of
476 + uploading your processed file [default: ]
477 +
478 + -s, --source-file TEXT The Project path of the source file of your
479 + processed files.
480 +
481 + --zip Upload folder as a compressed zip file.
482 + -td, --thread INTEGER The number of thread for upload a file [default:
483 + 1]
484 +
485 + -o, --output-path TEXT The output path for the manifest file of
486 + resumable upload [default: ./manifest.json]
487 +
488 + --help Show this message and exit.
489 +{{/code}}
490 +
491 +=== Examples ===
492 +
493 +Upload a file (or folder) to a specified directory of a Project’s Green Room, in this case the file located at {{code}}./sample_folder/sample_file1{{/code}} will be uploaded to the folder “admin” in the Project with the Project Code “cli” {{code}}(-p cli/admin){{/code}}:
494 +
495 +{{code language="none"}}
496 +$ pilotcli file upload ./sample_folder/sample_file1 -p cli/admin
497 +Starting upload of: ./sample_folder/sample_file1
498 +Pre-upload complete.
499 +uploader: admin container_id: 18061 total_size: 1048576 total_chunks: 1 uniq_identifier: e958247c-ce05-48b2-9038-78b774836256-1627498771 resumable_relative_path admin/
500 +
501 +Upload job is finalizing, please wait...
502 +Upload job complete.
503 +All files uploaded successfully.
504 +{{/code}}
505 +
506 +In case the specified destination directory does not exist yet, you will be prompted to confirm its creation by entering “y”, or to abort the command by entering “N”:
507 +
508 +{{code language="none"}}
509 +Target folder does not exist. Would you like to create a new folder? [y/N]: y
510 +{{/code}}
511 +
512 +In order to upload a file (or folder) to a destination directory in a Project's Core, core must be specified as corresponding zone {{code}}(-z core){{/code}} and you will be required to provide a message to that should describe the files` content and why you are uploading it directly into the Core {{code}}(-m "sample message"){{/code}}. Moreover, you will be reminded about the Terms of Use of the Platform and additional considerations regarding the direct upload of data into the Core zone, and are prompted to confirm your intention to proceed with the upload by entering “y” or “Yes”:
513 +
514 +
515 +
516 +
517 +
458 458  ----
459 459  
460 460  -