Box: Create Folder
Creates a new folder in the specified folder on Box and saves the folder ID and URL. When there is a folder with the same name, save that folder ID and URL.
Configs
  • C1: OAuth2 Setting *
  • C2: Parent Folder ID (Root Folder if blank)#{EL}
  • C3: Folder Name to create *#{EL}
  • C4: Data Item that will save Folder ID
  • C5: Data Item that will save Folder URL
Script (click to open)

main();
function main(){
  const newFolderName = configs.get("FolderName");
  checkNewFolderName(newFolderName);

  const parentFolderId = configs.get("ParentFolderId");
  
  // get OAuth2 Setting
  const oauth2 = configs.get("conf_OAuth2");

  const newFolderId = createFolder(oauth2, parentFolderId, newFolderName);

  const IdData = configs.get("FolderIdItem");
  const UrlData = configs.get("WebViewUrlItem");
  if (IdData !== null && IdData !== "") {
      engine.setDataByNumber(IdData, newFolderId);
  }
  if (UrlData !== null && UrlData !== "") {
      engine.setDataByNumber(UrlData, `https://app.box.com/folder/${newFolderId}`);
  }
}

/**
  * 新しいフォルダのフォルダ名をチェックする。(サポートされていない文字が使われていないか)
  */
function checkNewFolderName(newFolderName){

  //空ではないか
  if(newFolderName === "" ||newFolderName === null) {
    throw "Folder Name is blank";
  }

  //255文字を超えていないか
  if(newFolderName.length > 255){
    throw"Folder Name shoule be less than 256 characters";
  }

  //「/」や「\」が含まれていないか
  const reg = new RegExp('[/\\\\]');
  if(newFolderName.search(reg) !== -1) {
    throw "Invalid Folder Name";
  }

  //先頭と末尾に半角スペースが使われていないか
  if(newFolderName.slice(0,1) === " " || newFolderName.slice(-1) === " ") {
    throw "Invalid Folder Name";
  }

  //「.」や「..」ではないか
  if(newFolderName === "." || newFolderName === ".."){
    throw "Invalid Folder Name";
  }
}

//create folder on box
function createFolder(oauth2, parentFolderId, name) {
  let jsonReq = {};
  //mime type of google drive folder
  if (parentFolderId !== "" && parentFolderId !== null){
    jsonReq["parent"] = {"id": parentFolderId };
  }else{
    jsonReq["parent"]= {"id": 0 };
  }
  jsonReq["name"] = name;
  
  const url = 'https://api.box.com/2.0/folders';
  const response = httpClient.begin()
    .authSetting(oauth2)
    .body(JSON.stringify(jsonReq), "application/json; charset=UTF-8")
    .post(url);
  const status = response.getStatusCode();
  const responseTxt = response.getResponseAsString();

  engine.log(`status: ${status}`);
  engine.log(responseTxt);

  let jsonRes;
  try {
    jsonRes = JSON.parse(responseTxt);
  } catch(e) {
    engine.log("failed to parse as json");
    throw `Failed to create. status: ${status}`;
  }

  // フォルダ作成成功
  if (status === 201) {
    return jsonRes.id;
  }
  try {
    // 同名のフォルダがすでにある
    if(status === 409 && jsonRes.context_info.conflicts[0].type === "folder"){
      return jsonRes.context_info.conflicts[0].id;
    }
  } catch (e) {
    // 何もしない(上記2つのケース以外はすべてエラーにする)
  }
  throw `Failed to create. status: ${status}`;
}

Download

2021-03-19 (C) Questetra, Inc. (MIT License)
https://support.questetra.com/addons/box-folder-create/
The Addon-import feature is available with Professional or Enterprise edition.

Notes

  1. The Folder ID is contained in the URL: https://{sub-domain}.app.box.com/folder/(Folder ID)
  2. The refresh token for Box has an expiration date. Use regularly to ensure that it does not exceed the expiration. (Box: Token & URL Expiration)

Capture

See also

1 thought on “Box: Create Folder”

  1. Pingback: Utilising Box From Your Workflow – Questetra Support

Comments are closed.

%d bloggers like this: