1. worksheet
Application API
  • V3 (AI-friendly-beta)
    • Overview
    • Field Type Comparison Table
    • Guidelines for Using Filters
    • Error Code
    • application
      • Get application information
    • worksheet
      • Get Worksheet List
        POST
      • Create worksheet
        POST
      • Get worksheet structure information
        GET
      • Update worksheet structure
        POST
      • Delete worksheet
        DELETE
      • Get worksheet list
        POST
    • worksheet Row Records
      • Create row record
      • Get row record list
      • Batch create row records
      • Batch update row record details
      • Batch delete row records
      • Get row record details
      • Update row record
      • Delete row record
      • Get row record discussions
      • Get row record logs
      • Get row record pivot data
      • Get related records
      • Get record share link
    • option set
      • Get option set list
      • Create option set
      • Edit option set
      • Deactivate option set
    • workflow
      • Get workflow list
      • Get workflow details
      • Trigger workflow
      • Get the list of approval workflow executions by worksheet ID and row ID
      • Get approval workflow execution detail
    • role
      • Get role list
      • Create role
      • Get role details
      • Delete role
      • Add role member
      • Remove role member
      • Remove member from all roles
    • public query
      • Find member
      • Find department
      • Get region information
    • knowledge
      • Get list of knowledge bases under an application
      • Knowledge base search
  • V2
    • Filter
    • Development Guide
    • Filter Demo
    • ErrorCode
    • Options Set
      • Add Option Set
      • Get Option Set
      • Edit Option Set
      • Delete Option Set
    • Application Role
      • Get Application Role List GET
      • Create Application Role
      • Delete Application Role
      • Add Application Role Member
      • Remove Application Role Member
      • Exit application
      • Get Role Details
    • worksheet
      • Create Worksheet
      • Get worksheet structure information
      • Get List
      • Create Row Record
      • Batch Create Row Records
      • Get Row Record Details
      • Get row record details
      • Update Row Record Details
      • Batch Update Row Record Details
      • Delete Row Record
      • Get associated record
      • Get Record Share Link
      • Get total row count of worksheet
      • Get Row Record Log
    • app
      • Get Application Information
    • Public Inquiries
      • Get regional Information
    • Get Row Record Discussions
      POST
  • Schemas
    • Sample Schemas
      • option
      • relation
      • Pet
      • Category
      • Tag
    • Schemas
      • Authentication Information
      • obj_base_response
      • Person object
      • obj_field
      • Custom Page
      • obj_filter
      • Application Role
      • obj_record_row
      • obj_record_log
      • obj_record_discussion
      • obj_pivot_meta
      • obj_pivot_dimensions
      • obj_pivot_data
      • obj_process
      • obj_process_detail
      • obj_input
      • obj_output
      • obj_role
      • obj_role_permission
      • obj_user
      • obj_user_desensitized
      • obj_department
      • obj_custom_page
      • obj_optionset
      • obj_filter_children
      • obj_app
    • Base response object
    • memberInfo
    • department_with_path
    • departmentInfo
    • regionInfo
    • process
    • process_detail
    • input
    • output
    • role
    • role_permission
    • custom_page
    • optionset
    • field
    • worksheet
    • filter
    • filter_children
    • record_row
    • discussion
  1. worksheet

Update worksheet structure

POST
/v3/app/worksheets/{worksheet_id}
Update worksheet structure, including adding, editing, and deleting fields.

Request

Path Params

Header Params

Body Params application/jsonRequired

Example
{
    "name": "string",
    "alias": "string",
    "remark": "string",
    "sectionId": "string",
    "addFields": [
        {
            "name": "string",
            "type": 0,
            "alias": "string",
            "remark": "string",
            "desc": "string",
            "required": false,
            "isTitle": false,
            "isHidden": false,
            "isReadOnly": false,
            "isHiddenOnCreate": false,
            "isUnique": false,
            "precision": 0,
            "subType": "string",
            "options": [
                {
                    "value": "string",
                    "index": 0
                }
            ],
            "relation": {
                "showFields": [
                    "string"
                ],
                "bidirectional": true
            },
            "max": 0,
            "dataSource": "string",
            "sourceField": "string"
        }
    ],
    "editFields": [
        {
            "id": "string",
            "name": "string",
            "type": 0,
            "alias": "string",
            "remark": "string",
            "desc": "string",
            "required": false,
            "isTitle": false,
            "isHidden": false,
            "isReadOnly": false,
            "isHiddenOnCreate": false,
            "isUnique": false,
            "precision": 0,
            "subType": "string",
            "options": [
                {
                    "value": "string",
                    "index": 0
                }
            ],
            "relation": {
                "showFields": [
                    "string"
                ]
            },
            "max": 0,
            "dataSource": "string",
            "sourceField": "string"
        }
    ],
    "removeFields": [
        "string"
    ]
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://www.nocoly.com/v3/app/worksheets/' \
--header 'HAP-Appkey;' \
--header 'HAP-Sign;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "alias": "string",
    "remark": "string",
    "sectionId": "string",
    "addFields": [
        {
            "name": "string",
            "type": 0,
            "alias": "string",
            "remark": "string",
            "desc": "string",
            "required": false,
            "isTitle": false,
            "isHidden": false,
            "isReadOnly": false,
            "isHiddenOnCreate": false,
            "isUnique": false,
            "precision": 0,
            "subType": "string",
            "options": [
                {
                    "value": "string",
                    "index": 0
                }
            ],
            "relation": {
                "showFields": [
                    "string"
                ],
                "bidirectional": true
            },
            "max": 0,
            "dataSource": "string",
            "sourceField": "string"
        }
    ],
    "editFields": [
        {
            "id": "string",
            "name": "string",
            "type": 0,
            "alias": "string",
            "remark": "string",
            "desc": "string",
            "required": false,
            "isTitle": false,
            "isHidden": false,
            "isReadOnly": false,
            "isHiddenOnCreate": false,
            "isUnique": false,
            "precision": 0,
            "subType": "string",
            "options": [
                {
                    "value": "string",
                    "index": 0
                }
            ],
            "relation": {
                "showFields": [
                    "string"
                ]
            },
            "max": 0,
            "dataSource": "string",
            "sourceField": "string"
        }
    ],
    "removeFields": [
        "string"
    ]
}'

Responses

🟢200OK
application/json
Worksheet structure updated successfully
Body

Example
{
    "success": true,
    "error_code": 0,
    "error_msg": "string",
    "data": {}
}
Modified at 2026-03-30 07:15:12
Previous
Get worksheet structure information
Next
Delete worksheet
Built with