logo Windmill Hub
Login
Back to Airtable integration
0

Get Record or Create

by
Published today

Retrieve a record by ID; if the ID is empty or no such record exists, create one from the given fields.

Script airtable Verified
Use in Windmill

The script

Submitted by hugo989 Typescript (fetch-only)
Verified 2 hours ago
All edits
Permalink
1 
//native
2
3 
export type DynSelect_base_id = string
4 
export type DynSelect_table_id = string
5
6 
// Dropdown of the bases the token can access.
7 
export async function base_id(auth: RT.Airtable) {
8 
  const options: { value: string; label: string }[] = []
9 
  let offset: string | undefined = undefined
10 
  do {
11 
    const url = new URL("https://api.airtable.com/v0/meta/bases")
12 
    if (offset) {
13 
      url.searchParams.append("offset", offset)
14 
    }
15 
    const response = await fetch(url, {
16 
      headers: {
17 
        Authorization: `Bearer ${auth.apiKey}`,
18 
        Accept: "application/json",
19 
      },
20 
    })
21 
    if (!response.ok) {
22 
      throw new Error(`${response.status} ${await response.text()}`)
23 
    }
24 
    const page = (await response.json()) as {
25 
      bases: { id: string; name: string }[]
26 
      offset?: string
27 
    }
28 
    options.push(...page.bases.map((b) => ({ value: b.id, label: b.name })))
29 
    offset = page.offset
30 
  } while (offset)
31 
  return options
32 
}
33
34 
async function listTables(auth: RT.Airtable, base_id: string) {
35 
  if (!base_id) {
36 
    return []
37 
  }
38 
  const response = await fetch(
39 
    `https://api.airtable.com/v0/meta/bases/${base_id}/tables`,
40 
    {
41 
      headers: {
42 
        Authorization: `Bearer ${auth.apiKey}`,
43 
        Accept: "application/json",
44 
      },
45 
    }
46 
  )
47 
  if (!response.ok) {
48 
    throw new Error(`${response.status} ${await response.text()}`)
49 
  }
50 
  const { tables } = (await response.json()) as {
51 
    tables: {
52 
      id: string
53 
      name: string
54 
      fields: { id: string; name: string; type: string }[]
55 
      views: { id: string; name: string }[]
56 
    }[]
57 
  }
58 
  return tables
59 
}
60
61 
// Dropdown of the tables in the chosen base.
62 
export async function table_id(auth: RT.Airtable, base_id: DynSelect_base_id) {
63 
  return (await listTables(auth, base_id)).map((t) => ({
64 
    value: t.id,
65 
    label: t.name,
66 
  }))
67 
}
68
69 
/**
70 
 * Get Record or Create
71 
 * Retrieve a record by ID; if record_id is empty or no such record exists, create a new record from fields instead.
72 
 */
73 
export async function main(
74 
  auth: RT.Airtable,
75 
  base_id: DynSelect_base_id,
76 
  table_id: DynSelect_table_id,
77 
  record_id: string | undefined,
78 
  fields: { [key: string]: any },
79 
  typecast: boolean | undefined,
80 
  return_fields_by_field_id: boolean | undefined
81 
) {
82 
  if (record_id != null && record_id !== "") {
83 
    const url = new URL(
84 
      `https://api.airtable.com/v0/${base_id}/${table_id}/${record_id}`
85 
    )
86 
    if (return_fields_by_field_id === true) {
87 
      url.searchParams.append("returnFieldsByFieldId", "true")
88 
    }
89 
    const found = await fetch(url, {
90 
      headers: {
91 
        Authorization: `Bearer ${auth.apiKey}`,
92 
        Accept: "application/json",
93 
      },
94 
    })
95 
    if (found.ok) {
96 
      return await found.json()
97 
    }
98 
    // A record that doesn't exist answers 403 INVALID_PERMISSIONS_OR_MODEL_NOT_FOUND (404 for a
99 
    // malformed ID); a real permission problem fails the create below the same way.
100 
    if (found.status !== 404 && found.status !== 403) {
101 
      throw new Error(`${found.status} ${await found.text()}`)
102 
    }
103 
  }
104
105 
  const response = await fetch(
106 
    `https://api.airtable.com/v0/${base_id}/${table_id}`,
107 
    {
108 
      method: "POST",
109 
      headers: {
110 
        Authorization: `Bearer ${auth.apiKey}`,
111 
        "Content-Type": "application/json",
112 
        Accept: "application/json",
113 
      },
114 
      body: JSON.stringify({
115 
        fields,
116 
        typecast: typecast === true,
117 
        returnFieldsByFieldId: return_fields_by_field_id === true,
118 
      }),
119 
    }
120 
  )
121 
  if (!response.ok) {
122 
    throw new Error(`${response.status} ${await response.text()}`)
123 
  }
124
125 
  return await response.json()
126 
}
127