Create Datasheet

We will show you how to Create a datasheet.

Example: create datasheet

Suppose you have a space and you want to create a datasheet in the space.

Your action steps below:

1. Get your API Token.(How to get it)

2. Get your Space ID.(How to get it)

3. Get the ID (not required) of the folder to which it belongs.(How to get it)

4. Open the terminal on your computer, execute the following code and send the query request to the server (e.g. spaceId is spcjXzqVrjaP3):

   cURL

   curl -X POST \
   "https://aitable.ai/fusion/v1/spaces/spcjXzqVrjaP3/datasheets" \
   -H "Authorization: Bearer {Your API Token}" \
   -H 'Content-Type: application/json' \
   -d '{
    "name": "Title",
    "description": "Description",
    "folderId": "Not required, belong to the folder ID",
    "preNodeId": "Not required, previous node ID",
    "fields": [
      {
        "type": "Text",
        "name": "Title"
      }
    ]
   }'

   Javascript SDK

   Note: Need to Download and initialize Javascript SDK first, and then execute the following command.

   import { APITable } from 'apitable';
   
   const apitable = new APITable({
    token: 'Your API Token',
   });
   
   // Referring to IAddOpenFieldProperty, different FieldType corresponds to different Property structures
   const property = {
    defaultValue: 'Default value',
   };
   
   const fieldRo = {
    name: 'New text field',
    type: 'SingleText',
    property,
   };
   
   const datasheetRo = {
    name: 'New unit test datasheet',
    fields: [fieldRo],
   };
   
   try {
    const res = await apitable.space('spcjXzqVrjaP3').datasheets.create(datasheetRo);
    if (res.success) {
      for (const field of res.data.fields) {
        // TODO: save field.id
      }
    }
   } catch (error) {
    // TODO: handle error
   }

   Python SDK

   Note: You need to download and initialize the Python SDK first, and then execute the following command.

   from apitable import Apitable
   
   apitable = Apitable("Your API Token")
   
   prop = {
       'defaultValue': 'Default value'
   }
   field = {
       'name': 'New text field',
       'type': 'SingleText',
       'property': prop
   }
   req_data = {
       'name': 'New unit test datasheet',
       'fields': [field]
   }
   try:
       datasheet = apitable.space('spcjXzqVrjaP3').datasheets.create(req_data)
   except Exception:
       # Handling abnormal situations
       pass
   

5. The server returns the following JSON packets, below the "views" is all created datasheet:

   For the meaning of each parameter in the response, please check the API Reference

      {
        "success": true,
        "code": 200,
        "message": "SUCCESS",
        "data": {
          "id": "dstbs2U7mt8AEqgKuh",
          "createdAt": 1648648690000,
          "fields": [
            {
              "id": "fldupsvkR2ATB",
              "name": "title"
            }
          ]
        }
      }