List¶

GET /api/v1/outer_function/list

Overview¶

List the Func functions that OpenAPI is allowed to execute

Query Parameters¶

Parameter	Type	Description
_fuzzySearch	string	Fuzzy search query field Example: Super VIP template Allow empty: False
funcId	string	Search by function Id Example: Super VIP template Allow empty: False
funcTitle	string	Search by function title, using Like query Example: Super VIP template Allow empty: False
funcTags	commaarray	Function tags, used to filter functions by tags Example: Allow empty: False
funcScriptId	string	Script collection ID Example:

Additional Parameter Notes¶

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/outer_function/list' \
  -H 'Content-Type: application/json' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --compressed

Response¶

{
    "code": 200,
    "content": [
        {
            "argsJSON": [
                "workspace_uuid",
                "workspace_token",
                "your_name"
            ],
            "category": "openapi",
            "definition": "test(workspace_uuid, workspace_token, your_name='OpenAPI User')",
            "description": "The test interface is mainly to facilitate users in testing whether DataFlux Func can be successfully connected through OpenAPI",
            "extraConfigJSON": null,
            "id": "example__openapi.test",
            "integration": null,
            "kwargsJSON": {
                "workspace_token": {},
                "workspace_uuid": {},
                "your_name": {
                    "default": "OpenAPI user"
                }
            },
            "name": "test",
            "scriptDescription": null,
            "scriptId": "example__openapi",
            "scriptSetDescription": null,
            "scriptSetId": "Guance Cloud",
            "scriptSetTitle": "Guance ",
            "scriptTitle": null,
            "tagsJSON": null,
            "title": "test",
            "url": "/api/v1/func/example__openapi.test"
        },
        {
            "argsJSON": [
                "workspace_uuid",
                "workspace_token",
                "data"
            ],
            "category": "openapi",
            "definition": "report_event(workspace_uuid, workspace_token, data)",
            "description": "desc",
            "extraConfigJSON": null,
            "id": "example__openapi.report_event",
            "integration": null,
            "kwargsJSON": {
                "data": {},
                "workspace_token": {},
                "workspace_uuid": {}
            },
            "name": "report_event",
            "scriptDescription": null,
            "scriptId": "example__openapi",
            "scriptSetDescription": null,
            "scriptSetId": "truewatch",
            "scriptSetTitle": "Guance Cloud support",
            "scriptTitle": null,
            "tagsJSON": null,
            "title": "Report Event",
            "url": "/api/v1/func/example__openapi.report_event"
        }
    ],
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-1B02BD5D-D249-4D56-8762-9D6CB31FF0D1"
}