List drives - Panora Documentation

GET

filestorage

drives

import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.filestorage.drives.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });

  for await (const page of result) {
    // handle page
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "name": "school",
      "remote_created_at": "2024-10-01T12:00:00Z",
      "drive_url": "https://example.com/school",
      "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "id_1",
      "remote_data": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}

Authorizations

x-api-key

string

header

required

Headers

x-connection-token

string

required

The connection token

Query Parameters

remote_data

boolean

Set to true to include data from the original software.

limit

number

default:50

Set to get the number of records.

cursor

string

Set to get the number of records after this cursor.

Response

200 - application/json

prev_cursor

string | null

required

next_cursor

string | null

required

data

object[]

required

data.name

string | null

required

The name of the drive

Example:

"school"

data.remote_created_at

string | null

required

When the third party s drive was created.

Example:

"2024-10-01T12:00:00Z"

data.drive_url

string | null

required

The url of the drive

Example:

"https://example.com/school"

data.field_mappings

object | null

The custom field mappings of the object between the remote 3rd party & Panora

Example:

{
  "fav_dish": "broccoli",
  "fav_color": "red"
}

data.id

string | null

The UUID of the drive

Example:

"801f9ede-c698-4e66-a7fc-48d19eebaa4f"

data.remote_id

string | null

The id of the drive in the context of the 3rd Party

Example:

"id_1"

data.remote_data

object | null

The remote data of the drive in the context of the 3rd Party

Example:

{
  "fav_dish": "broccoli",
  "fav_color": "red"
}

data.created_at

string | null

The created date of the object

Example:

"2024-10-01T12:00:00Z"

data.modified_at

string | null

The modified date of the object

Example:

"2024-10-01T12:00:00Z"

Was this page helpful?

Suggest edits Raise issue

Overview Retrieve a drive

import { Panora } from "@panora/sdk";

const panora = new Panora({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await panora.filestorage.drives.list({
    xConnectionToken: "<value>",
    remoteData: true,
    limit: 10,
    cursor: "1b8b05bb-5273-4012-b520-8657b0b90874",
  });

  for await (const page of result) {
    // handle page
  }
}

run();

{
  "prev_cursor": "<string>",
  "next_cursor": "<string>",
  "data": [
    {
      "name": "school",
      "remote_created_at": "2024-10-01T12:00:00Z",
      "drive_url": "https://example.com/school",
      "field_mappings": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "id": "801f9ede-c698-4e66-a7fc-48d19eebaa4f",
      "remote_id": "id_1",
      "remote_data": {
        "fav_dish": "broccoli",
        "fav_color": "red"
      },
      "created_at": "2024-10-01T12:00:00Z",
      "modified_at": "2024-10-01T12:00:00Z"
    }
  ]
}

File Storage Objects

Authorizations

Headers

Query Parameters

Response