Skip to content

Latest commit

 

History

History
117 lines (88 loc) · 4.08 KB

files.md

File metadata and controls

117 lines (88 loc) · 4.08 KB

Files Actions

Details on the various actions that can be performed on the Files resource, including the expected parameters and the potential responses.

Contents

Get

Returns the files for an application

var params = {
  applicationId: myApplicationId
};

// with callbacks
client.files.get(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.files.get(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.cli, all.User.read, files.*, or files.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: lastUpdated, type, name, creationDate lastUpdated subject
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
page string N Which page of results to return 0 0
perPage string N How many items to return per page 100 10
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name name
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. myFile
type string N Limit by the type (file or directory) of the file file
status string N Limit the result to only files of this status. Accepted values are: completed, pending completed
directory string N Get files that are inside of this directory /a/path/
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Files Schema Collection of files

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post

Create a new file for an application

var params = {
  applicationId: myApplicationId,
  file: myFile
};

// with callbacks
client.files.post(params, function (err, result) {
  if (err) { return console.error(err); }
  console.log(result);
});

// with promises
client.files.post(params)
  .then(console.log)
  .catch(console.error);

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.cli, all.Organization, all.User, all.User.cli, files.*, or files.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
file File Post Y New file information File Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 File Upload Post Response Successfully created file and returned a post url to respond with

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found