logo Windmill Hub
Login
Back to Microsoft Sharepoint integration
0

Move or Rename File or Folder

by
Published today

Move a file or folder to another folder of the same drive, rename it, or both. `item` and `destination_folder` are each an id, or a path from the drive root starting with "/" (e.g. `/Reports/2026/summary.xlsx`). To move across drives, copy then delete. Requires Sites.ReadWrite.All (a connection default).

Script ms_sharepoint Verified
Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 5 hours ago
All edits
Permalink
1 
//native
2
3 
const graph = "https://graph.microsoft.com/v1.0"
4
5 
export type DynSelect_site_id = string
6
7 
export async function site_id(auth: RT.MsSharepoint) {
8 
  const response = await fetch(
9 
    `${graph}/sites?search=*&$select=id,displayName,webUrl&$top=200`,
10 
    {
11 
      headers: {
12 
        Authorization: `Bearer ${auth.token}`,
13 
        Accept: "application/json",
14 
      },
15 
    }
16 
  )
17 
  if (!response.ok) {
18 
    throw new Error(`${response.status} ${await response.text()}`)
19 
  }
20 
  const { value } = (await response.json()) as {
21 
    value: { id: string; displayName: string; webUrl: string }[]
22 
  }
23 
  return value.map((s) => ({
24 
    value: s.id,
25 
    label: `${s.displayName} (${s.webUrl})`,
26 
  }))
27 
}
28
29 
export type DynSelect_drive_id = string
30
31 
export async function drive_id(auth: RT.MsSharepoint, site_id: string) {
32 
  const response = await fetch(
33 
    `${graph}/sites/${site_id}/drives?$select=id,name`,
34 
    {
35 
      headers: {
36 
        Authorization: `Bearer ${auth.token}`,
37 
        Accept: "application/json",
38 
      },
39 
    }
40 
  )
41 
  if (!response.ok) {
42 
    throw new Error(`${response.status} ${await response.text()}`)
43 
  }
44 
  const { value } = (await response.json()) as {
45 
    value: { id: string; name: string }[]
46 
  }
47 
  return value.map((d) => ({ value: d.id, label: d.name }))
48 
}
49
50 
// The site's default document library, or the library given by drive_id
51 
function driveUrl(site_id: string, drive_id: string | undefined) {
52 
  return drive_id != null && drive_id !== ""
53 
    ? `${graph}/drives/${encodeURIComponent(drive_id)}`
54 
    : `${graph}/sites/${site_id}/drive`
55 
}
56
57 
// An item is addressed by its id, or by a path from the drive root starting with "/"
58 
function ref(item: string | undefined) {
59 
  if (item == null || item === "" || item === "/") return "root"
60 
  if (!item.startsWith("/")) return `items/${encodeURIComponent(item)}`
61 
  const path = item
62 
    .replace(/\/+$/, "")
63 
    .split("/")
64 
    .map(encodeURIComponent)
65 
    .join("/")
66 
  return `root:${path}:`
67 
}
68
69 
async function folderId(
70 
  token: string,
71 
  drive: string,
72 
  folder: string
73 
): Promise<string> {
74 
  if (!folder.startsWith("/")) return folder
75 
  const response = await fetch(`${drive}/${ref(folder)}?$select=id`, {
76 
    headers: { Authorization: `Bearer ${token}`, Accept: "application/json" },
77 
  })
78 
  if (!response.ok) {
79 
    throw new Error(`${response.status} ${await response.text()}`)
80 
  }
81 
  return ((await response.json()) as { id: string }).id
82 
}
83
84 
/**
85 
 * Move or Rename File or Folder
86 
 * Move a file or folder to another folder of the same drive, rename it, or both. `item` and `destination_folder` are each an id, or a path from the drive root starting with "/" (e.g. `/Reports/2026/summary.xlsx`). To move across drives, copy then delete. Requires Sites.ReadWrite.All (a connection default).
87 
 */
88 
export async function main(
89 
  auth: RT.MsSharepoint,
90 
  site_id: DynSelect_site_id,
91 
  item: string,
92 
  destination_folder: string | undefined,
93 
  new_name: string | undefined,
94 
  drive_id: DynSelect_drive_id | undefined
95 
) {
96 
  const drive = driveUrl(site_id, drive_id)
97 
  const body: { [key: string]: any } = {}
98 
  if (new_name != null && new_name !== "") body.name = new_name
99 
  if (destination_folder != null && destination_folder !== "") {
100 
    body.parentReference = {
101 
      id: await folderId(auth.token, drive, destination_folder),
102 
    }
103 
  }
104 
  if (Object.keys(body).length === 0) {
105 
    throw new Error("Provide destination_folder, new_name or both")
106 
  }
107
108 
  const response = await fetch(`${drive}/${ref(item)}`, {
109 
    method: "PATCH",
110 
    headers: {
111 
      Authorization: `Bearer ${auth.token}`,
112 
      "Content-Type": "application/json",
113 
      Accept: "application/json",
114 
    },
115 
    body: JSON.stringify(body),
116 
  })
117
118 
  if (!response.ok) {
119 
    throw new Error(`${response.status} ${await response.text()}`)
120 
  }
121
122 
  return await response.json()
123 
}
124