Matt Aitken
1201 lines
36 KiB
JSON
1201 lines
36 KiB
JSON
{
|
|
"title": "AirtableTypes}",
|
|
"anyOf": [
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "Create records body",
|
|
"properties": {
|
|
"typecast": {
|
|
"title": "typecast",
|
|
"type": "boolean",
|
|
"description": "If set to true, Airtable will try to convert string values into the appropriate cell value. This conversion is only performed on a best-effort basis. To ensure your data's integrity, this should only be used when necessary. Defaults to false when unset."
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
},
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records to update/upsert",
|
|
"items": {
|
|
"type": "object",
|
|
"title": "Record",
|
|
"properties": {
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
}
|
|
},
|
|
"required": [
|
|
"fields"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"title": "CreateRecordsInput"
|
|
},
|
|
{
|
|
"title": "CreateRecordsOutput",
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"title": "Multiple records created response",
|
|
"properties": {
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records",
|
|
"items": {
|
|
"$ref": "#/definitions/Record"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"records"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "Single record created response",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
},
|
|
"createdTime": {
|
|
"type": "string",
|
|
"title": "createdTime",
|
|
"description": "A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\""
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdTime",
|
|
"fields"
|
|
]
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
},
|
|
"recordId": {
|
|
"type": "string",
|
|
"description": "The ID of the record"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName",
|
|
"recordId"
|
|
]
|
|
}
|
|
],
|
|
"title": "DeleteRecordInput"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "DeleteRecordOutput",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
},
|
|
"deleted": {
|
|
"title": "deleted",
|
|
"type": "boolean",
|
|
"description": "Whether the record was deleted",
|
|
"enum": [
|
|
true
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"deleted"
|
|
]
|
|
},
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
},
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records to delete",
|
|
"items": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
},
|
|
"description": "An array of record IDs to delete"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName",
|
|
"records"
|
|
]
|
|
}
|
|
],
|
|
"title": "DeleteRecordsInput"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "DeleteRecordsOutput",
|
|
"properties": {
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records",
|
|
"items": {
|
|
"type": "object",
|
|
"title": "Deleted record",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
},
|
|
"deleted": {
|
|
"title": "deleted",
|
|
"type": "boolean",
|
|
"description": "Whether the record was deleted",
|
|
"enum": [
|
|
true
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"deleted"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"records"
|
|
]
|
|
},
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
},
|
|
"recordId": {
|
|
"type": "string",
|
|
"description": "The ID of the record"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName",
|
|
"recordId"
|
|
]
|
|
}
|
|
],
|
|
"title": "GetRecordInput"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "GetRecordOutput",
|
|
"properties": {
|
|
"createdTime": {
|
|
"type": "string",
|
|
"title": "createdTime",
|
|
"description": "When the record was created"
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"title": "id",
|
|
"description": "The record id"
|
|
}
|
|
},
|
|
"required": [
|
|
"createdTime",
|
|
"fields",
|
|
"id"
|
|
]
|
|
},
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "List records body",
|
|
"properties": {
|
|
"timeZone": {
|
|
"title": "Timezone",
|
|
"description": "The time zone that should be used to format dates when using string as the cellFormat. This parameter is required when using string as the cellFormat",
|
|
"type": "string",
|
|
"enum": [
|
|
"utc",
|
|
"client",
|
|
"Africa/Abidjan",
|
|
"Africa/Accra",
|
|
"Africa/Addis_Ababa",
|
|
"Africa/Algiers",
|
|
"Africa/Asmara",
|
|
"Africa/Bamako",
|
|
"Africa/Bangui",
|
|
"Africa/Banjul",
|
|
"Africa/Bissau",
|
|
"Africa/Blantyre",
|
|
"Africa/Brazzaville",
|
|
"Africa/Bujumbura",
|
|
"Africa/Cairo",
|
|
"Africa/Casablanca",
|
|
"Africa/Ceuta",
|
|
"Africa/Conakry",
|
|
"Africa/Dakar",
|
|
"Africa/Dar_es_Salaam",
|
|
"Africa/Djibouti",
|
|
"Africa/Douala",
|
|
"Africa/El_Aaiun",
|
|
"Africa/Freetown",
|
|
"Africa/Gaborone",
|
|
"Africa/Harare",
|
|
"Africa/Johannesburg",
|
|
"Africa/Juba",
|
|
"Africa/Kampala",
|
|
"Africa/Khartoum",
|
|
"Africa/Kigali",
|
|
"Africa/Kinshasa",
|
|
"Africa/Lagos",
|
|
"Africa/Libreville",
|
|
"Africa/Lome",
|
|
"Africa/Luanda",
|
|
"Africa/Lubumbashi",
|
|
"Africa/Lusaka",
|
|
"Africa/Malabo",
|
|
"Africa/Maputo",
|
|
"Africa/Maseru",
|
|
"Africa/Mbabane",
|
|
"Africa/Mogadishu",
|
|
"Africa/Monrovia",
|
|
"Africa/Nairobi",
|
|
"Africa/Ndjamena",
|
|
"Africa/Niamey",
|
|
"Africa/Nouakchott",
|
|
"Africa/Ouagadougou",
|
|
"Africa/Porto-Novo",
|
|
"Africa/Sao_Tome",
|
|
"Africa/Tripoli",
|
|
"Africa/Tunis",
|
|
"Africa/Windhoek",
|
|
"America/Adak",
|
|
"America/Anchorage",
|
|
"America/Anguilla",
|
|
"America/Antigua",
|
|
"America/Araguaina",
|
|
"America/Argentina/Buenos_Aires",
|
|
"America/Argentina/Catamarca",
|
|
"America/Argentina/Cordoba",
|
|
"America/Argentina/Jujuy",
|
|
"America/Argentina/La_Rioja",
|
|
"America/Argentina/Mendoza",
|
|
"America/Argentina/Rio_Gallegos",
|
|
"America/Argentina/Salta",
|
|
"America/Argentina/San_Juan",
|
|
"America/Argentina/San_Luis",
|
|
"America/Argentina/Tucuman",
|
|
"America/Argentina/Ushuaia",
|
|
"America/Aruba",
|
|
"America/Asuncion",
|
|
"America/Atikokan",
|
|
"America/Bahia",
|
|
"America/Bahia_Banderas",
|
|
"America/Barbados",
|
|
"America/Belem",
|
|
"America/Belize",
|
|
"America/Blanc-Sablon",
|
|
"America/Boa_Vista",
|
|
"America/Bogota",
|
|
"America/Boise",
|
|
"America/Cambridge_Bay",
|
|
"America/Campo_Grande",
|
|
"America/Cancun",
|
|
"America/Caracas",
|
|
"America/Cayenne",
|
|
"America/Cayman",
|
|
"America/Chicago",
|
|
"America/Chihuahua",
|
|
"America/Costa_Rica",
|
|
"America/Creston",
|
|
"America/Cuiaba",
|
|
"America/Curacao",
|
|
"America/Danmarkshavn",
|
|
"America/Dawson",
|
|
"America/Dawson_Creek",
|
|
"America/Denver",
|
|
"America/Detroit",
|
|
"America/Dominica",
|
|
"America/Edmonton",
|
|
"America/Eirunepe",
|
|
"America/El_Salvador",
|
|
"America/Fort_Nelson",
|
|
"America/Fortaleza",
|
|
"America/Glace_Bay",
|
|
"America/Godthab",
|
|
"America/Goose_Bay",
|
|
"America/Grand_Turk",
|
|
"America/Grenada",
|
|
"America/Guadeloupe",
|
|
"America/Guatemala",
|
|
"America/Guayaquil",
|
|
"America/Guyana",
|
|
"America/Halifax",
|
|
"America/Havana",
|
|
"America/Hermosillo",
|
|
"America/Indiana/Indianapolis",
|
|
"America/Indiana/Knox",
|
|
"America/Indiana/Marengo",
|
|
"America/Indiana/Petersburg",
|
|
"America/Indiana/Tell_City",
|
|
"America/Indiana/Vevay",
|
|
"America/Indiana/Vincennes",
|
|
"America/Indiana/Winamac",
|
|
"America/Inuvik",
|
|
"America/Iqaluit",
|
|
"America/Jamaica",
|
|
"America/Juneau",
|
|
"America/Kentucky/Louisville",
|
|
"America/Kentucky/Monticello",
|
|
"America/Kralendijk",
|
|
"America/La_Paz",
|
|
"America/Lima",
|
|
"America/Los_Angeles",
|
|
"America/Lower_Princes",
|
|
"America/Maceio",
|
|
"America/Managua",
|
|
"America/Manaus",
|
|
"America/Marigot",
|
|
"America/Martinique",
|
|
"America/Matamoros",
|
|
"America/Mazatlan",
|
|
"America/Menominee",
|
|
"America/Merida",
|
|
"America/Metlakatla",
|
|
"America/Mexico_City",
|
|
"America/Miquelon",
|
|
"America/Moncton",
|
|
"America/Monterrey",
|
|
"America/Montevideo",
|
|
"America/Montserrat",
|
|
"America/Nassau",
|
|
"America/New_York",
|
|
"America/Nipigon",
|
|
"America/Nome",
|
|
"America/Noronha",
|
|
"America/North_Dakota/Beulah",
|
|
"America/North_Dakota/Center",
|
|
"America/North_Dakota/New_Salem",
|
|
"America/Nuuk",
|
|
"America/Ojinaga",
|
|
"America/Panama",
|
|
"America/Pangnirtung",
|
|
"America/Paramaribo",
|
|
"America/Phoenix",
|
|
"America/Port-au-Prince",
|
|
"America/Port_of_Spain",
|
|
"America/Porto_Velho",
|
|
"America/Puerto_Rico",
|
|
"America/Punta_Arenas",
|
|
"America/Rainy_River",
|
|
"America/Rankin_Inlet",
|
|
"America/Recife",
|
|
"America/Regina",
|
|
"America/Resolute",
|
|
"America/Rio_Branco",
|
|
"America/Santarem",
|
|
"America/Santiago",
|
|
"America/Santo_Domingo",
|
|
"America/Sao_Paulo",
|
|
"America/Scoresbysund",
|
|
"America/Sitka",
|
|
"America/St_Barthelemy",
|
|
"America/St_Johns",
|
|
"America/St_Kitts",
|
|
"America/St_Lucia",
|
|
"America/St_Thomas",
|
|
"America/St_Vincent",
|
|
"America/Swift_Current",
|
|
"America/Tegucigalpa",
|
|
"America/Thule",
|
|
"America/Thunder_Bay",
|
|
"America/Tijuana",
|
|
"America/Toronto",
|
|
"America/Tortola",
|
|
"America/Vancouver",
|
|
"America/Whitehorse",
|
|
"America/Winnipeg",
|
|
"America/Yakutat",
|
|
"America/Yellowknife",
|
|
"Antarctica/Casey",
|
|
"Antarctica/Davis",
|
|
"Antarctica/DumontDUrville",
|
|
"Antarctica/Macquarie",
|
|
"Antarctica/Mawson",
|
|
"Antarctica/McMurdo",
|
|
"Antarctica/Palmer",
|
|
"Antarctica/Rothera",
|
|
"Antarctica/Syowa",
|
|
"Antarctica/Troll",
|
|
"Antarctica/Vostok",
|
|
"Arctic/Longyearbyen",
|
|
"Asia/Aden",
|
|
"Asia/Almaty",
|
|
"Asia/Amman",
|
|
"Asia/Anadyr",
|
|
"Asia/Aqtau",
|
|
"Asia/Aqtobe",
|
|
"Asia/Ashgabat",
|
|
"Asia/Atyrau",
|
|
"Asia/Baghdad",
|
|
"Asia/Bahrain",
|
|
"Asia/Baku",
|
|
"Asia/Bangkok",
|
|
"Asia/Barnaul",
|
|
"Asia/Beirut",
|
|
"Asia/Bishkek",
|
|
"Asia/Brunei",
|
|
"Asia/Chita",
|
|
"Asia/Choibalsan",
|
|
"Asia/Colombo",
|
|
"Asia/Damascus",
|
|
"Asia/Dhaka",
|
|
"Asia/Dili",
|
|
"Asia/Dubai",
|
|
"Asia/Dushanbe",
|
|
"Asia/Famagusta",
|
|
"Asia/Gaza",
|
|
"Asia/Hebron",
|
|
"Asia/Ho_Chi_Minh",
|
|
"Asia/Hong_Kong",
|
|
"Asia/Hovd",
|
|
"Asia/Irkutsk",
|
|
"Asia/Istanbul",
|
|
"Asia/Jakarta",
|
|
"Asia/Jayapura",
|
|
"Asia/Jerusalem",
|
|
"Asia/Kabul",
|
|
"Asia/Kamchatka",
|
|
"Asia/Karachi",
|
|
"Asia/Kathmandu",
|
|
"Asia/Khandyga",
|
|
"Asia/Kolkata",
|
|
"Asia/Krasnoyarsk",
|
|
"Asia/Kuala_Lumpur",
|
|
"Asia/Kuching",
|
|
"Asia/Kuwait",
|
|
"Asia/Macau",
|
|
"Asia/Magadan",
|
|
"Asia/Makassar",
|
|
"Asia/Manila",
|
|
"Asia/Muscat",
|
|
"Asia/Nicosia",
|
|
"Asia/Novokuznetsk",
|
|
"Asia/Novosibirsk",
|
|
"Asia/Omsk",
|
|
"Asia/Oral",
|
|
"Asia/Phnom_Penh",
|
|
"Asia/Pontianak",
|
|
"Asia/Pyongyang",
|
|
"Asia/Qatar",
|
|
"Asia/Qostanay",
|
|
"Asia/Qyzylorda",
|
|
"Asia/Rangoon",
|
|
"Asia/Riyadh",
|
|
"Asia/Sakhalin",
|
|
"Asia/Samarkand",
|
|
"Asia/Seoul",
|
|
"Asia/Shanghai",
|
|
"Asia/Singapore",
|
|
"Asia/Srednekolymsk",
|
|
"Asia/Taipei",
|
|
"Asia/Tashkent",
|
|
"Asia/Tbilisi",
|
|
"Asia/Tehran",
|
|
"Asia/Thimphu",
|
|
"Asia/Tokyo",
|
|
"Asia/Tomsk",
|
|
"Asia/Ulaanbaatar",
|
|
"Asia/Urumqi",
|
|
"Asia/Ust-Nera",
|
|
"Asia/Vientiane",
|
|
"Asia/Vladivostok",
|
|
"Asia/Yakutsk",
|
|
"Asia/Yangon",
|
|
"Asia/Yekaterinburg",
|
|
"Asia/Yerevan",
|
|
"Atlantic/Azores",
|
|
"Atlantic/Bermuda",
|
|
"Atlantic/Canary",
|
|
"Atlantic/Cape_Verde",
|
|
"Atlantic/Faroe",
|
|
"Atlantic/Madeira",
|
|
"Atlantic/Reykjavik",
|
|
"Atlantic/South_Georgia",
|
|
"Atlantic/St_Helena",
|
|
"Atlantic/Stanley",
|
|
"Australia/Adelaide",
|
|
"Australia/Brisbane",
|
|
"Australia/Broken_Hill",
|
|
"Australia/Currie",
|
|
"Australia/Darwin",
|
|
"Australia/Eucla",
|
|
"Australia/Hobart",
|
|
"Australia/Lindeman",
|
|
"Australia/Lord_Howe",
|
|
"Australia/Melbourne",
|
|
"Australia/Perth",
|
|
"Australia/Sydney",
|
|
"Europe/Amsterdam",
|
|
"Europe/Andorra",
|
|
"Europe/Astrakhan",
|
|
"Europe/Athens",
|
|
"Europe/Belgrade",
|
|
"Europe/Berlin",
|
|
"Europe/Bratislava",
|
|
"Europe/Brussels",
|
|
"Europe/Bucharest",
|
|
"Europe/Budapest",
|
|
"Europe/Busingen",
|
|
"Europe/Chisinau",
|
|
"Europe/Copenhagen",
|
|
"Europe/Dublin",
|
|
"Europe/Gibraltar",
|
|
"Europe/Guernsey",
|
|
"Europe/Helsinki",
|
|
"Europe/Isle_of_Man",
|
|
"Europe/Istanbul",
|
|
"Europe/Jersey",
|
|
"Europe/Kaliningrad",
|
|
"Europe/Kiev",
|
|
"Europe/Kirov",
|
|
"Europe/Lisbon",
|
|
"Europe/Ljubljana",
|
|
"Europe/London",
|
|
"Europe/Luxembourg",
|
|
"Europe/Madrid",
|
|
"Europe/Malta",
|
|
"Europe/Mariehamn",
|
|
"Europe/Minsk",
|
|
"Europe/Monaco",
|
|
"Europe/Moscow",
|
|
"Europe/Nicosia",
|
|
"Europe/Oslo",
|
|
"Europe/Paris",
|
|
"Europe/Podgorica",
|
|
"Europe/Prague",
|
|
"Europe/Riga",
|
|
"Europe/Rome",
|
|
"Europe/Samara",
|
|
"Europe/San_Marino",
|
|
"Europe/Sarajevo",
|
|
"Europe/Saratov",
|
|
"Europe/Simferopol",
|
|
"Europe/Skopje",
|
|
"Europe/Sofia",
|
|
"Europe/Stockholm",
|
|
"Europe/Tallinn",
|
|
"Europe/Tirane",
|
|
"Europe/Ulyanovsk",
|
|
"Europe/Uzhgorod",
|
|
"Europe/Vaduz",
|
|
"Europe/Vatican",
|
|
"Europe/Vienna",
|
|
"Europe/Vilnius",
|
|
"Europe/Volgograd",
|
|
"Europe/Warsaw",
|
|
"Europe/Zagreb",
|
|
"Europe/Zaporozhye",
|
|
"Europe/Zurich",
|
|
"Indian/Antananarivo",
|
|
"Indian/Chagos",
|
|
"Indian/Christmas",
|
|
"Indian/Cocos",
|
|
"Indian/Comoro",
|
|
"Indian/Kerguelen",
|
|
"Indian/Mahe",
|
|
"Indian/Maldives",
|
|
"Indian/Mauritius",
|
|
"Indian/Mayotte",
|
|
"Indian/Reunion",
|
|
"Pacific/Apia",
|
|
"Pacific/Auckland",
|
|
"Pacific/Bougainville",
|
|
"Pacific/Chatham",
|
|
"Pacific/Chuuk",
|
|
"Pacific/Easter",
|
|
"Pacific/Efate",
|
|
"Pacific/Enderbury",
|
|
"Pacific/Fakaofo",
|
|
"Pacific/Fiji",
|
|
"Pacific/Funafuti",
|
|
"Pacific/Galapagos",
|
|
"Pacific/Gambier",
|
|
"Pacific/Guadalcanal",
|
|
"Pacific/Guam",
|
|
"Pacific/Honolulu",
|
|
"Pacific/Kanton",
|
|
"Pacific/Kiritimati",
|
|
"Pacific/Kosrae",
|
|
"Pacific/Kwajalein",
|
|
"Pacific/Majuro",
|
|
"Pacific/Marquesas",
|
|
"Pacific/Midway",
|
|
"Pacific/Nauru",
|
|
"Pacific/Niue",
|
|
"Pacific/Norfolk",
|
|
"Pacific/Noumea",
|
|
"Pacific/Pago_Pago",
|
|
"Pacific/Palau",
|
|
"Pacific/Pitcairn",
|
|
"Pacific/Pohnpei",
|
|
"Pacific/Port_Moresby",
|
|
"Pacific/Rarotonga",
|
|
"Pacific/Saipan",
|
|
"Pacific/Tahiti",
|
|
"Pacific/Tarawa",
|
|
"Pacific/Tongatapu",
|
|
"Pacific/Wake",
|
|
"Pacific/Wallis"
|
|
]
|
|
},
|
|
"userLocal": {
|
|
"type": "string",
|
|
"title": "userLocal",
|
|
"description": "The user locale that should be used to format dates when using string as the cellFormat. This parameter is required when using string as the cellFormat."
|
|
},
|
|
"pageSize": {
|
|
"type": "number",
|
|
"title": "pageSize",
|
|
"description": "The number of records returned in each request. Must be less than or equal to 100. Default is 100."
|
|
},
|
|
"maxRecords": {
|
|
"type": "number",
|
|
"title": "maxRecords",
|
|
"description": "The maximum total number of records that will be returned in your requests. If this value is larger than pageSize (which is 100 by default), you may have to load multiple pages to reach this total."
|
|
},
|
|
"offset": {
|
|
"type": "string",
|
|
"title": "offset",
|
|
"description": "To fetch the next page of records, include offset from the previous request in the next request's parameters."
|
|
},
|
|
"view": {
|
|
"type": "string",
|
|
"title": "view",
|
|
"description": "The name or ID of a view in the table. If set, only the records in that view will be returned. The records will be sorted according to the order of the view unless the sort parameter is included, which overrides that order. Fields hidden in this view will be returned in the results. To only return a subset of fields, use the fields parameter."
|
|
},
|
|
"sort": {
|
|
"type": "array",
|
|
"title": "Sort",
|
|
"items": {
|
|
"type": "object",
|
|
"title": "Sort field",
|
|
"properties": {
|
|
"direction": {
|
|
"type": "string",
|
|
"title": "Direction",
|
|
"description": "Direction",
|
|
"enum": [
|
|
"asc",
|
|
"desc"
|
|
]
|
|
},
|
|
"field": {
|
|
"type": "string",
|
|
"title": "Field name"
|
|
}
|
|
},
|
|
"required": [
|
|
"field"
|
|
]
|
|
}
|
|
},
|
|
"filterByFormula": {
|
|
"type": "string",
|
|
"title": "filterByFormula",
|
|
"description": "A formula used to filter records. The formula will be evaluated for each record, and if the result is not 0, false, \"\", NaN, [], or #Error! the record will be included in the response. If combined with the view parameter, only records in that view which satisfy the formula will be returned. For example, to only include records where the column named \"Category\" equals \"Programming\", pass in: filterByFormula={Category}=\"Programming\""
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"title": "Only data for fields whose names or IDs are in this list will be included in the result. If you don't need every field, you can use this parameter to reduce the amount of data transferred.",
|
|
"items": {
|
|
"type": "string",
|
|
"title": "Field name"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"title": "ListRecordsInput"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "ListRecordsOutput",
|
|
"properties": {
|
|
"offset": {
|
|
"type": "string",
|
|
"title": "offset",
|
|
"description": "To fetch the next page of records, include offset from the previous request in the next request's parameters."
|
|
},
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records",
|
|
"items": {
|
|
"$ref": "#/definitions/Record"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"records"
|
|
]
|
|
},
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
},
|
|
"recordId": {
|
|
"type": "string",
|
|
"description": "The ID of the record"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName",
|
|
"recordId"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "Update record body",
|
|
"properties": {
|
|
"typecast": {
|
|
"title": "typecast",
|
|
"type": "boolean",
|
|
"description": "If set to true, Airtable will try to convert string values into the appropriate cell value. This conversion is only performed on a best-effort basis. To ensure your data's integrity, this should only be used when necessary. Defaults to false when unset."
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
}
|
|
},
|
|
"required": [
|
|
"fields"
|
|
]
|
|
}
|
|
],
|
|
"title": "UpdateRecordInput"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "UpdateRecordOutput",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
},
|
|
"createdTime": {
|
|
"type": "string",
|
|
"title": "createdTime",
|
|
"description": "A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\""
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdTime",
|
|
"fields"
|
|
]
|
|
},
|
|
{
|
|
"allOf": [
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"baseId": {
|
|
"type": "string",
|
|
"description": "The ID of the base"
|
|
},
|
|
"tableIdOrName": {
|
|
"type": "string",
|
|
"description": "The name or id of the table"
|
|
}
|
|
},
|
|
"required": [
|
|
"baseId",
|
|
"tableIdOrName"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "Update records body",
|
|
"properties": {
|
|
"performUpsert": {
|
|
"type": "object",
|
|
"title": "Perform upsert",
|
|
"properties": {
|
|
"fieldsToMergeOn": {
|
|
"type": "array",
|
|
"title": "Fields to merge on",
|
|
"items": {
|
|
"type": "string",
|
|
"title": "Field name"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"fieldsToMergeOn"
|
|
]
|
|
},
|
|
"typecast": {
|
|
"title": "typecast",
|
|
"type": "boolean",
|
|
"description": "If set to true, Airtable will try to convert string values into the appropriate cell value. This conversion is only performed on a best-effort basis. To ensure your data's integrity, this should only be used when necessary. Defaults to false when unset."
|
|
},
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records to update/upsert",
|
|
"items": {
|
|
"type": "object",
|
|
"title": "Record",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "id",
|
|
"description": "Record ID. Required when performUpsert is not set."
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
}
|
|
},
|
|
"required": [
|
|
"fields"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"records"
|
|
]
|
|
}
|
|
],
|
|
"title": "UpdateRecordsInput"
|
|
},
|
|
{
|
|
"title": "UpdateRecordsOutput",
|
|
"anyOf": [
|
|
{
|
|
"type": "object",
|
|
"title": "Update response",
|
|
"properties": {
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records",
|
|
"items": {
|
|
"$ref": "#/definitions/Record"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"records"
|
|
]
|
|
},
|
|
{
|
|
"type": "object",
|
|
"title": "Upsert response",
|
|
"properties": {
|
|
"createdRecords": {
|
|
"type": "array",
|
|
"title": "Created records",
|
|
"items": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
}
|
|
},
|
|
"updatedRecords": {
|
|
"type": "array",
|
|
"title": "Updated records",
|
|
"items": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
}
|
|
},
|
|
"records": {
|
|
"type": "array",
|
|
"title": "Records",
|
|
"items": {
|
|
"$ref": "#/definitions/Record"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"createdRecords",
|
|
"updatedRecords",
|
|
"records"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"definitions": {
|
|
"AThumbnail": {
|
|
"type": "object",
|
|
"title": "A Thumbnail",
|
|
"properties": {
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Thumbnail URL"
|
|
},
|
|
"width": {
|
|
"type": "number",
|
|
"title": "Thumbnail Width"
|
|
},
|
|
"height": {
|
|
"type": "number",
|
|
"title": "Thumbnail Height"
|
|
}
|
|
},
|
|
"required": [
|
|
"url",
|
|
"width",
|
|
"height"
|
|
],
|
|
"additionalProperties": true
|
|
},
|
|
"Thumbnails": {
|
|
"type": "object",
|
|
"title": "Thumbnails",
|
|
"properties": {
|
|
"small": {
|
|
"$ref": "#/definitions/AThumbnail"
|
|
},
|
|
"large": {
|
|
"$ref": "#/definitions/AThumbnail"
|
|
},
|
|
"full": {
|
|
"$ref": "#/definitions/AThumbnail"
|
|
}
|
|
},
|
|
"required": [
|
|
"small",
|
|
"large",
|
|
"full"
|
|
],
|
|
"additionalProperties": true
|
|
},
|
|
"AnAttachment": {
|
|
"type": "object",
|
|
"title": "An Attachment",
|
|
"properties": {
|
|
"height": {
|
|
"type": "number",
|
|
"title": "Attachment Height"
|
|
},
|
|
"width": {
|
|
"type": "number",
|
|
"title": "Attachment Width"
|
|
},
|
|
"thumbnails": {
|
|
"$ref": "#/definitions/Thumbnails"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Attachment ID"
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"title": "Attachment URL"
|
|
},
|
|
"filename": {
|
|
"type": "string",
|
|
"title": "Attachment Filename"
|
|
},
|
|
"size": {
|
|
"type": "number",
|
|
"title": "Attachment Size"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "Attachment Type"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"url",
|
|
"filename",
|
|
"size",
|
|
"type"
|
|
],
|
|
"additionalProperties": true
|
|
},
|
|
"ACollaborator": {
|
|
"type": "object",
|
|
"title": "A Collaborator",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Collaborator ID"
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"title": "Collaborator Email"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Collaborator Name"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"email",
|
|
"name"
|
|
],
|
|
"additionalProperties": true
|
|
},
|
|
"Fields": {
|
|
"type": "object",
|
|
"title": "Fields",
|
|
"additionalProperties": {
|
|
"title": "FieldValue",
|
|
"oneOf": [
|
|
{
|
|
"type": "string",
|
|
"title": "StringValue"
|
|
},
|
|
{
|
|
"type": "number",
|
|
"title": "NumberValue"
|
|
},
|
|
{
|
|
"title": "BooleanValue",
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/ACollaborator"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"title": "Collaborators",
|
|
"items": {
|
|
"$ref": "#/definitions/ACollaborator"
|
|
}
|
|
},
|
|
{
|
|
"type": "array",
|
|
"title": "StringValues",
|
|
"items": {
|
|
"type": "string",
|
|
"title": "StringValue"
|
|
}
|
|
},
|
|
{
|
|
"type": "array",
|
|
"title": "Attachments",
|
|
"items": {
|
|
"$ref": "#/definitions/AnAttachment"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"Record": {
|
|
"type": "object",
|
|
"title": "Record",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"title": "Record ID"
|
|
},
|
|
"createdTime": {
|
|
"type": "string",
|
|
"title": "createdTime",
|
|
"description": "A date timestamp in the ISO format, eg:\"2018-01-01T00:00:00.000Z\""
|
|
},
|
|
"fields": {
|
|
"$ref": "#/definitions/Fields"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"createdTime",
|
|
"fields"
|
|
]
|
|
}
|
|
}
|
|
} |