Requests

A Request is a file that should be uploaded by a specific user or group.

Requests can either be manually created and managed, or managed automatically by an Automation.

List Requests

Command

files-cli requests list

Output

Outputs a list of Request objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--mine
boolean		Only show requests of the current user? (Defaults to true if current user is not a site admin.)
--path=
string		Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Additional Arguments

Example Request

files-cli requests list

List Requests

Command

files-cli requests get-folder

Output

Outputs a list of Request objects according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--mine
boolean		Only show requests of the current user? (Defaults to true if current user is not a site admin.)
--path=
string
Required		Path to show requests for. If omitted, shows all paths. Send / to represent the root directory.

Additional Arguments

Example Request

files-cli requests get-folder \
  --path="path"

Create Request

Command

files-cli requests create

Output

Outputs a Request object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--path=
string
Required		Folder path on which to request the file.
--destination=
string
Required		Destination filename (without extension) to request.
--user-ids=
string		A list of user IDs to request the file from. If sent as a string, it should be comma-delimited.
--group-ids=
string		A list of group IDs to request the file from. If sent as a string, it should be comma-delimited.

Example Request

files-cli requests create \
  --path="path" \
  --destination="destination"

Delete Request

Command

files-cli requests delete

Output

No output is returned.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

FlagDescription
--id=
int64
Required		Request ID.

Example Request

files-cli requests delete \
  --id=1

The Request Object

Some of the commands above return a Request object. The attributes of this object are listed below.

AttributeDescription
id
int64		Request ID
path
string		Folder path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
source
string		Source filename, if applicable
destination
string		Destination filename
automation_id
int64		ID of automation that created request
user_display_name
string		User making the request (if applicable)