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

SDK Method

Files::Request.list

Return Object

List<Request>

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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

begin
  requests = Files::Request.list(
    mine: false
  )
  requests.auto_paging_each do |request|
    # Operate on request
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

List Requests

SDK Method

Files::Request.get_folder

Return Object

List<Request>

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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

begin
  requests = Files::Request.get_folder(path, 
    mine: false
  )
  requests.auto_paging_each do |request|
    # Operate on request
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Request

SDK Method

Files::Request.create

Return Object

Request

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
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

begin
  request = Files::Request.create(
    path: "path",
    destination: "destination"
  )
  # Operate on request
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Request

SDK Method

request.delete

Return Object

nil

Authorization Requirement

Available to all authenticated keys or sessions.

Example Request

begin
  request = Files::Request.list.first
  request.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The Request Object

Some of the methods 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)