Skip to content

Latest commit

 

History

History
173 lines (124 loc) · 6.99 KB

file-requests.md

File metadata and controls

173 lines (124 loc) · 6.99 KB
Raw

box file-requests

Copies existing file request to new folder

box file-requests:copy ID FOLDERID

Copies existing file request to new folder

USAGE
  $ box file-requests:copy ID FOLDERID

ARGUMENTS
  ID        ID of the file request to copy
  FOLDERID  ID of folder to which file request will be copied

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --description=description              New description of file request

  --[no-]description-required            is file request submitter required to provide a description of the files they
                                         are submitting

  --[no-]email-required                  New date when file request expires

  --expires-at=expires-at                New date when file request expires

  --fields=fields                        Comma separated list of fields to show

  --json                                 Output formatted JSON

  --no-color                             Turn off colors for logging

  --save-to-file-path=save-to-file-path  Override default file path to save report

  --status=active|inactive               New status of file request

  --title=title                          New title of file request

EXAMPLE
  box file-requests:copy 22222 44444

See code: src/commands/file-requests/copy.js

box file-requests:delete ID

Delete individual file request

USAGE
  $ box file-requests:delete ID

ARGUMENTS
  ID  ID of the file request to delete

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

EXAMPLE
  box file-requests:delete 12345

See code: src/commands/file-requests/delete.js

box file-requests:get ID

Get information about an file request

USAGE
  $ box file-requests:get ID

ARGUMENTS
  ID  ID of the file request to get

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --fields=fields                        Comma separated list of fields to show
  --json                                 Output formatted JSON
  --no-color                             Turn off colors for logging
  --save-to-file-path=save-to-file-path  Override default file path to save report

EXAMPLE
  box file-requests:get 12345

See code: src/commands/file-requests/get.js

box file-requests:update ID

Update a file request

USAGE
  $ box file-requests:update ID

ARGUMENTS
  ID  ID of the file request to update

OPTIONS
  -h, --help                             Show CLI help
  -q, --quiet                            Suppress any non-error output to stderr
  -s, --save                             Save report to default reports folder on disk
  -t, --token=token                      Provide a token to perform this call
  -v, --verbose                          Show verbose output, which can be helpful for debugging
  -y, --yes                              Automatically respond yes to all confirmation prompts
  --as-user=as-user                      Provide an ID for a user
  --bulk-file-path=bulk-file-path        File path to bulk .csv or .json objects
  --csv                                  Output formatted CSV
  --description=description              New description of file request

  --[no-]description-required            is file request submitter required to provide a description of the files they
                                         are submitting

  --[no-]email-required                  New date when file request expires

  --etag=etag                            Pass in the item's last observed etag value into this header and the endpoint
                                         will fail with a 412 Precondition Failed if it has changed since.

  --expires-at=expires-at                New date when file request expires

  --fields=fields                        Comma separated list of fields to show

  --json                                 Output formatted JSON

  --no-color                             Turn off colors for logging

  --save-to-file-path=save-to-file-path  Override default file path to save report

  --status=active|inactive               New status of file request

  --title=title                          New title of file request

EXAMPLE
  box file-requests:update 12345 --description "New file request description!"

See code: src/commands/file-requests/update.js