Enumerating Libraries

Enumerating libraries is how you generate the list of Print Portal root folders. Outside of authentication (when necessary), this is the first step to being able to print a document by using automation.

ClosedTo enumerate libraries

The return page in the browser is JSON format content that enumerates root folders. The "id" that is returned for the Librarian root folder will be used in subsequent examples.

{

"id":"b49be392-c6ec-43e9-a7ad-c8b23f8d3c4c",

"name":"Templates",

"description":"Sample documents included with the BarTender Designer",

"order":0,

"fileFilter":"*.btw",

"relativePath":"Templates",

"validVisibleUsers":[]},

{"id":"de6940a6-ff73-465b-aaf2-d39504420fa6",

"name":"Librarian",

"description":"Files that have been added to Librarian.",

"order":1,

"fileFilter":"*.btw",

"relativePath":"lib://",

"validVisibleUsers":[]

}

ClosedJavaScript Example

Copy
//*---------------------------------------------------------------------------------------
 Enumerate files within a given root folder with authentication enabled */

let basePrintPortalURL = "https://example.com/Bartender/";
let route = "libraries/";
let token = "token_value_from_authentication_call";

fetch(basePrintPortalURL + route, {
    method: 'get',
    headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer ' + token
  },
    })
.then(response => response.json())
.then(result => {
  console.log(result);

  // In case of multiple libraries, the following will display each library ID individually
 
    for (const library of result)
    {

    // Displays the libraryID(s), the ID can be used in another request to gather information about an individual library
    console.log(library.id);

    // Displays the name(s) of each library
    console.log(library.name);

    // Displays the relative path of each library
    console.log(library.relativePath);
    }

  // Displays the specific error message in case of a failed request
  console.log(result.errors.id);
  
  // Displays the title of the error message
  console.log(result.title);

  // Displays the error message status code
  console.log(result.status);

  })
  .catch(error => {
    console.error('There has been a problem with your fetch operation: ', error.message);
  });