Application API
    • Overview
    • Development Guide
    • Filter Demo
    • Guidelines for Using Filters
    • Field Type Comparison Table
    • ErrorCode
    • App
      • Get app information
        GET
      • Batch create app item groups
        POST
      • Batch create app items
        POST
    • Conversational bot
      • Create conversation bot
        POST
    • Worksheet
      • Get worksheet list
        POST
      • Create worksheet
        POST
      • Get worksheet structure information
        GET
      • Update worksheet structure
        POST
      • Delete worksheet
        DELETE
      • Batch create custom actions
        POST
    • Worksheet row records
      • Get row record list
        POST
      • Get row record details
        GET
      • Update row record
        PATCH
      • Delete row record
        DELETE
      • Create row record
        POST
      • Batch add row records
        POST
      • Batch update row record details
        PATCH
      • Batch delete row records
        DELETE
      • Get relation records
        GET
      • Get row record pivot data
        POST
      • Get record sharing link
        POST
      • Get row record logs
        GET
      • Get row record discussions
        GET
      • Get approval workflow execution details
        GET
      • Get approval process execution list by row record
        POST
    • Custom page
      • Updatecustom Page
    • Option set
      • Get option set list
      • Create option set
      • Edit option set
      • Disable option set
    • Public query
      • Find member
      • Find department
      • Get region information
    • Knowledge base
      • Get knowledge base list under the app
      • Knowledge base search
    • view
      • Batchcreateview
    • Workflow
      • Get trigger process list
      • Createworkflow
      • BatchcontentWorkflownode
      • Deleteworkflownode
      • Trigger workflow
      • Get trigger process details
      • Deleteworkflow
      • Get workflow structure details
      • Publishworkflow
      • Validateworkflow
    • Role
      • Get role list
      • Create role
      • Get role details
      • Delete role
      • Add role members
      • Remove role members
      • Member exits all roles
    • Chart
      • Createchart
    • Schemas
      • Schemas
        • options
        • relation
        • obj_base_response
        • obj_field
        • obj_filter
        • 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
      • FilterTarget
      • FilterField
      • 鉴权信息
      • 人员对象
      • 自定义页面
      • 应用角色
      • 人员信息
      • 统计图数值字段参数
      • ApiError
      • BatchCreateViewsRequest
      • DataScope
      • ViewItem
      • Aggregation
      • BatchCreateViewsResponse
      • TimeRange
      • ChartType
      • DynamicRangePoint
      • DimensionItem
      • MetricItem
      • SortItem
      • CreateChartData
      • InlineChartConfig
      • ViewConfig
      • TextConfig
      • HtmlConfig
      • CarouselConfig
      • ButtonActionItem
      • ButtonConfig
      • TabConfig
      • ContainerConfig
      • ChartComponent
      • SectionComponent
      • TextComponent
      • HtmlComponent
      • ViewComponent
      • CarouselComponent
      • ButtonComponent
      • TabComponent
      • ContainerComponent
      • SaveCustomPageComponent
      • SaveCustomPageData
      • ComponentConfig
      • SaveCustomPageRequest
      • app
      • CreateChartRequest
      • SaveCustomPageResponseData
      • CreateChartResponseData
      • ButtonItem
      • Base response object
      • DimensionField
      • memberInfo
      • ValueField
      • department_with_path
      • SortField
      • departmentInfo
      • TimePointDynamic
      • regionInfo
      • process
      • process_detail
      • CustomDynamicRange
      • input
      • CustomRange
      • output
      • role
      • role_permission
      • optionset
      • field
      • CreateChartResponse
      • PageComponent
      • Position
      • filter_children
      • ErrorResponse
      • discussion
      • TabItem
      • SaveCustomPageResponse
      • User
      • WorkflowInputParameter
      • WorkflowOutputParameter
      • WorkflowNode
      • WorkflowValidationError
      • create_process_NodeRef
      • create_process_ValueRef
      • create_process_FieldValueRef
      • create_process_Filter
      • create_process_Condition
      • create_process_WorksheetEventTriggerConfig
      • create_process_ScheduleTriggerConfig
      • create_process_DateFieldTriggerConfig
      • create_process_WebhookTriggerConfig
      • create_process_TriggerSpec
      • batch_create_process_nodes_NodeRef
      • batch_create_process_nodes_ValueRef
      • batch_create_process_nodes_FieldValueRef
      • batch_create_process_nodes_RecordValueRef
      • batch_create_process_nodes_FieldPatch
      • batch_create_process_nodes_Filter
      • batch_create_process_nodes_Condition
      • batch_create_process_nodes_PersonRef
      • batch_create_process_nodes_AttachmentSpec
      • batch_create_process_nodes_FormProperty
      • batch_create_process_nodes_NodeSpec
      • batch_create_process_nodes_SortSpec
      • ApiResponseBase
      • WorkflowListType
      • WorkflowInstanceStatus
      • FlowNodeType
      • InstanceLogStatus
      • WorkItemOperationType
      • WorkItemLogAction
      • ApprovalAuthType
      • BatchRuleType
      • CallbackType
      • TriggerType
      • AppType
      • ApprovalResultBranchType
      • FailureCause
      • SignatureType
      • AppBrief
      • UserBrief
      • ControlValue
      • FlowNodeAuth
      • SelectNodeObject
      • FlowNode
      • InstanceLog
      • ProcessBrief
      • FileInfo
      • Signature
      • WorkItem
      • WorkItemLog
      • ChangedField
      • WorkflowInstance
      • BatchApprovalRequest
      • BatchApprovalInstance
      • BatchApprovalResult
      • OpinionRequest
      • ReturnRequest
      • bundled_2af3dc97c2fe
      • bundled_da9b1112b2d5
      • bundled_66310009f584
      • custom_page
      • worksheet
      • filter
      • record_row

    Development Guide

    Overview#

    This document provides a simple way to integrate Nocoly application data with any external application data. The API strictly follows REST semantics, uses JSON to encode objects, and relies on standard HTTP codes to indicate the results of operations.

    Request Format#

    For GET requests, all parameters are passed by concatenation after the URL.
    For POST requests, the body of the request must be in JSON format, and the Content-Type of the HTTP header needs to be set to application/json.

    Operation steps#

    1.
    Get the authorization key
    image.png
    2.
    When debugging the API, fill in your own AppKey and sign
    image.png
    Modified at 2025-08-21 09:09:00
    Previous
    Overview
    Next
    Filter Demo
    Built with