콘텐츠로 이동

목록¶

GET /api/v1/notes/list

개요¶

조건에 맞는 모든 노트를 나열합니다. 현재 이 API는 페이지네이션을 지원하지 않습니다.

쿼리 요청 파라미터¶

파라미터명	유형	필수	설명
search	string		노트 이름 검색 빈 값 허용: False

파라미터 추가 설명¶

파라미터 설명:

요청 예시¶

curl 'https://openapi.guance.com/api/v1/notes/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "data": [
            {
                "createAt": 1642588739,
                "creator": "acnt_xxxx32",
                "creatorInfo": {
                    "iconUrl": "http://static.cloudcare.cn:10561/icon/acnt_xxxx32.png",
                    "name": "66",
                    "username": "xxx@guance.com"
                },
                "deleteAt": -1,
                "id": 185,
                "isFavourited": false,
                "name": "My Notes",
                "pos": [
                    {
                        "chartUUID": "chrt_xxxx32"
                    }
                ],
                "status": 0,
                "updateAt": 1642588739,
                "updator": "acnt_xxxx32",
                "updatorInfo": {
                    "iconUrl": "http://static.cloudcare.cn:10561/icon/acnt_xxxx32.png",
                    "name": "66",
                    "username": "xxx@guance.com"
                },
                "uuid": "notes_xxxx32",
                "workspaceUUID": "wksp_xxxx32"
            }
        ]
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-123ADCD7-95F0-4EDC-A27A-649885FAF9CD"
}