コンテンツにスキップ

一覧表示¶

GET /api/v1/outer_function/list

概要¶

OpenAPI で実行可能な Func 関数の一覧を表示します。

Query リクエストパラメータ¶

パラメータ名	型	必須	説明
_fuzzySearch	string		あいまい検索クエリフィールド例: スーパーVIPテンプレート空の場合はFalse
funcId	string		関数IDで検索例: スーパーVIPテンプレート空の場合はFalse
funcTitle	string		関数タイトルで検索（LIKE方式）例: スーパーVIPテンプレート空の場合はFalse
funcTags	commaarray		関数タグ。タグで関数をフィルタリングする場合に使用例: 空の場合はFalse
funcScriptId	string		スクリプトコレクションID 例:

パラメータ補足説明¶

リクエスト例¶

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

レスポンス¶

{
    "code": 200,
    "content": [
        {
            "argsJSON": [
                "workspace_uuid",
                "workspace_token",
                "your_name"
            ],
            "category": "openapi",
            "definition": "test(workspace_uuid, workspace_token, your_name='OpenAPI User')",
            "description": "テストインターフェースは、主にユーザーが OpenAPI を介して DataFlux Func に正常に接続できるかどうかをテストするためのものです",
            "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": "説明",
            "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": "guance",
            "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"
}