View custom operator list

View the custom operators that can be read in the current workspace. The returned operator ID can be used to view, modify, test run, or delete the operator.

HTTP

GET $CLOUDSIGMA_API_BASE/workflow/v2/custom-operators

Before you call this API

Configure the regional API endpoint and authentication, and select the target workspace.

Request

Input examples

Shell

curl "$CLOUDSIGMA_API_BASE/workflow/v2/custom-operators?page_size=20&enabled=true" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID"

Parameter reference

Request parameters

Successful response

The response returns a custom operator that meets the conditions. When the response contains the next page token, use it as the page_token for the next request; if it is not returned, it means that the reading has been completed.

The response fields are as follows.

In this document, [] after a type denotes an array. In a field path, [] denotes each item in an array; for example, items[].name is the name field of each item in the items array.

Response example

JSON

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "items": [
      {
        "id": 123,
        "node_id": "moi:custom.operator:workspace:text_counter",
        "name": "文本计数",
        "identifier": "text_counter",
        "version": "v1",
        "enabled": true
      }
    ],
    "total": 1
  }
}

Show full code

Field reference

Field	Type	Description
code	string	OK on success.
msg	string	OK on success.
data.items[]	array	Custom operator list.
data.items[].id	integer	Custom operator ID, used for subsequent operations.
data.items[].node_id	string	Operator ID in the workflow.
data.items[].name	string	Operator name.
data.items[].identifier	string	Operator ID.
data.items[].description	string	Operator description; returned if there is a value.
data.items[].handler	string	Processing function; returns if there is a value.
data.items[].version	string	Operator version; returned if there is a value.
data.items[].isolation_level	string	Isolation configuration; returned if there is a value.
data.items[].language	integer	Implements the numerical encoding of the language; returns if there is a value.
data.items[].kind	integer	Numeric encoding of the operator type; returned if there is a value.
data.items[].source_file_id	string	Source file ID; returned when created using a source file.
data.items[].input_schema	string	Enter the defined serialization content; return if there is a value.
data.items[].output_schema	string	Output the defined serialized content; return if there is a value.
data.items[].binding_config	string	The serialized content of the binding configuration; returned if there is a value.
data.items[].created_by	string	Creator ID; returned if there is a value.
data.items[].updated_by	string	Last updater ID; returned if there is a value.
data.items[].created_at	integer	Creation timestamp; returned if there is a value.
data.items[].updated_at	integer	Last updated timestamp; returned if there is a value.
data.items[].base_node_id	string	The basic operator associated with the built-in binding type; returned when there is a value.
data.items[].base_node_version	string	The basic operator version associated with the built-in binding type; returned if there is a value.
data.items[].catalog_id	integer	The associated Catalog ID; returned if there is a value.
data.items[].database_id	integer	The associated database ID; returned if there is a value.
data.items[].enabled	boolean	Whether the operator is enabled.
data.total	integer	The total number of items that match the filter conditions.
data.next_page_token	string	Next page mark; does not return if there is no next page.

Error response

Response example

JSON

{
  "code": "ErrParamInvalid",
  "msg": "请求参数无效",
  "data": null
}

Field reference

Field	Type	Description
code	string	Error code.
msg	string	Readable error message.
data	null	`null` in an error response.

Follow-up operations

Query custom operator details.

Last updated on Sep 15, 2026