{
  "opencollection": "1.0.0",
  "info": {
    "name": "Baserow API spec Admin Database tables API",
    "version": "2.2.2"
  },
  "items": [
    {
      "info": {
        "name": "Database tables",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "get_periodic_data_sync_interval",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/data-sync/:data_sync_id/periodic-interval/",
            "params": [
              {
                "name": "data_sync_id",
                "value": "",
                "type": "path",
                "description": "The data sync where to fetch the periodic settings for."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Responds with the periodic data sync interval data, if the user has the right permissions.\nThis is an **enterprise** feature."
        },
        {
          "info": {
            "name": "update_periodic_data_sync_interval",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/data-sync/:data_sync_id/periodic-interval/",
            "params": [
              {
                "name": "data_sync_id",
                "value": "",
                "type": "path",
                "description": "Updates the data sync related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the periodic data sync interval, if the user has the right permissions.\nThis is an **enterprise** feature."
        },
        {
          "info": {
            "name": "get_table_data_sync",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/database/data-sync/:data_sync_id/",
            "params": [
              {
                "name": "data_sync_id",
                "value": "",
                "type": "path",
                "description": "The data sync that must be fetched."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Responds with the data sync, including the data sync type specific properties, if the user has the right permissions."
        },
        {
          "info": {
            "name": "update_table_data_sync",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/database/data-sync/:data_sync_id/",
            "params": [
              {
                "name": "data_sync_id",
                "value": "",
                "type": "path",
                "description": "Updates the data sync related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the properties of the provided data sync, if the user has the right permissions. Note that if the `synced_properties` is not provided, the available properties change, then the unavailable ones will automatically be removed."
        },
        {
          "info": {
            "name": "get_table_data_sync_properties",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/database/data-sync/:data_sync_id/properties/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "data_sync_id",
                "value": "",
                "type": "path",
                "description": "Lists properties related to the provided ID."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Lists all the available properties of the provided data sync."
        },
        {
          "info": {
            "name": "sync_data_sync_table_async",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/data-sync/:data_sync_id/sync/async/",
            "params": [
              {
                "name": "data_sync_id",
                "value": "",
                "type": "path",
                "description": "Starts a job to sync the data sync table related to the provided value."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Start a job to sync the data sync table with the provided `data_sync_id` parameter if the authorized user has access to the database's workspace."
        },
        {
          "info": {
            "name": "create_database_data_sync_table",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/data-sync/database/:database_id/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              },
              {
                "name": "ClientUndoRedoActionGroupId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "database_id",
                "value": "",
                "type": "path",
                "description": "Creates a data sync table for the database related to theprovided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a new data sync table with the given data sync type. This will technically create a table, but it's synchronized with the provided data sync information. This means that some fields related to it will automatically be created and will be read-only."
        },
        {
          "info": {
            "name": "get_table_data_sync_type_properties",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/data-sync/properties/",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Lists all the properties of the provided data sync type given the request data. This can be used to choose which properties should be included when creating the data sync."
        },
        {
          "info": {
            "name": "get_database_table",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/database/tables/:table_id/",
            "params": [
              {
                "name": "table_id",
                "value": "",
                "type": "path",
                "description": "Returns the table related to the provided value."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the requested table if the authorized user has access to the related database's workspace."
        },
        {
          "info": {
            "name": "update_database_table",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/api/database/tables/:table_id/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              },
              {
                "name": "ClientUndoRedoActionGroupId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "table_id",
                "value": "",
                "type": "path",
                "description": "Updates the table related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the existing table if the authorized user has access to the related database's workspace."
        },
        {
          "info": {
            "name": "delete_database_table",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/api/database/tables/:table_id/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              },
              {
                "name": "ClientUndoRedoActionGroupId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "table_id",
                "value": "",
                "type": "path",
                "description": "Deletes the table related to the provided value."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes the existing table if the authorized user has access to the related database's workspace."
        },
        {
          "info": {
            "name": "duplicate_database_table_async",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/tables/:table_id/duplicate/async/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              },
              {
                "name": "ClientUndoRedoActionGroupId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "table_id",
                "value": "",
                "type": "path",
                "description": "The table to duplicate."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Start a job to duplicate the table with the provided `table_id` parameter if the authorized user has access to the database's workspace."
        },
        {
          "info": {
            "name": "import_data_database_table_async",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/tables/:table_id/import/async/",
            "params": [
              {
                "name": "table_id",
                "value": "",
                "type": "path",
                "description": "Import data into the table related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Import data in the specified table if the authorized user has access to the related database's workspace. This endpoint is asynchronous and return the created job to track the progress of the task."
        },
        {
          "info": {
            "name": "list_all_token_tables",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/database/tables/all-tables/",
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "This endpoint only works in combination with the token authentication. It lists all the tables that the token has either create, read, update or delete access to."
        },
        {
          "info": {
            "name": "list_database_tables",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/database/tables/database/:database_id/",
            "params": [
              {
                "name": "database_id",
                "value": "",
                "type": "path",
                "description": "Returns only tables that are related to the provided value."
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Lists all the tables that are in the database related to the `database_id` parameter if the user has access to the database's workspace. A table is exactly as the name suggests. It can hold multiple fields, each having their own type and multiple rows. They can be added via the **create_database_table_field** and **create_database_table_row** endpoints."
        },
        {
          "info": {
            "name": "create_database_table",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/tables/database/:database_id/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              },
              {
                "name": "ClientUndoRedoActionGroupId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "database_id",
                "value": "",
                "type": "path",
                "description": "Creates a table for the database related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates synchronously a new table for the database related to the provided `database_id` parameter if the authorized user has access to the database's workspace.\n\nAs an alternative you can use the `create_async_database_table` for better performances and importing bigger files."
        },
        {
          "info": {
            "name": "create_database_table_async",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/tables/database/:database_id/async/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "database_id",
                "value": "",
                "type": "path",
                "description": "Creates a table for the database related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a job that creates a new table for the database related to the provided `database_id` parameter if the authorized user has access to the database's workspace. This endpoint is asynchronous and return the created job to track the progress of the task."
        },
        {
          "info": {
            "name": "order_database_tables",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/database/tables/database/:database_id/order/",
            "headers": [
              {
                "name": "ClientSessionId",
                "value": ""
              },
              {
                "name": "ClientUndoRedoActionGroupId",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "database_id",
                "value": "",
                "type": "path",
                "description": "Updates the order of the tables in the database related to the provided value."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Changes the order of the provided table ids to the matching position that the id has in the list. If the authorized user does not belong to the workspace it will be ignored. The order of the not provided tables will be set to `0`."
        }
      ]
    }
  ],
  "bundled": true
}