콘텐츠로 이동

목록



GET /api/v1/notes/list

개요

현재 워크스페이스에서 볼 수 있는 레거시 노트를 나열합니다.

호출 전 및 사용 단계

이름으로 필터링할 수 있으며 페이지네이션이 없습니다. 공개 노트와 현재 호출 ID로 생성된 비공개 노트를 나열할 수 있습니다. 기본적으로 즐겨찾기 항목이 먼저 표시되고 나머지는 생성 시간 내림차순으로 정렬됩니다. 결과 항목의 uuid로 상세 조회 또는 내보내기를 호출합니다.

요청 헤더

파라미터 이름 유형 필수 설명
DF-API-KEY string Y 워크스페이스의 OpenAPI 인증 자격 증명입니다.
예시: <DF-API-KEY>
가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다.

Query 요청 파라미터

파라미터 이름 유형 필수 설명
search string 이름 포함 일치입니다. 생략하거나 공백으로 입력하면 이름으로 필터링하지 않습니다.
null 허용: False
예시: 巡检
가져오기 또는 입력 방법: 노트 이름에서 키워드를 추출하여 URL 인코딩으로 전달합니다.

파라미터 추가 설명

응답의 data는 전체 일치 목록이며, 각 항목의 uuid를 직접 읽습니다.

요청 예시

curl --get 'https://openapi.guance.com/api/v1/notes/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode 'search=巡检'

응답

HTTP 200, application/json입니다. 아래 예시는 직접 읽을 수 있는 주요 필드를 보여줍니다.

필드 유형 설명
content.data array<object> 조건에 맞는 노트이며, 결과가 없으면 []입니다.
content.data[].id integer 노트 레코드 번호입니다.
content.data[].uuid string 노트 UUID로, 조회, 수정, 가져오기 및 삭제에 사용됩니다.
content.data[].name string 노트 이름입니다.
content.data[].workspaceUUID string 소속 워크스페이스입니다.
content.data[].isPublic integer 공개 범위이며, 1은 공개, 0은 생성 ID만 볼 수 있습니다.
content.data[].extend object 노트 확장 설정입니다.
content.data[].status integer 노트의 현재 상태입니다.
content.data[].creator string 생성자 ID입니다.
content.data[].updator string 최근 업데이트한 ID이며, 업데이트가 없으면 비어 있을 수 있습니다.
content.data[].createAt number 생성 시간이며 Unix 초 단위입니다.
content.data[].updateAt number 최근 업데이트 시간이며 Unix 초 단위입니다. 업데이트가 없으면 -1일 수 있습니다.
content.data[].deleteAt number 삭제 시간이며 Unix 초 단위입니다. 삭제되지 않았으면 -1입니다.
content.data[].pos array<object> 차트의 순서 참조 배열입니다.
content.data[].pos[].chartUUID string 차트 UUID입니다.
content.data[].creatorInfo object 생성자 정보이며, 찾지 못하면 빈 객체입니다.
content.data[].updatorInfo object 최근 업데이트한 사람의 정보이며, 찾지 못하면 빈 객체입니다.
content.data[].creatorInfo.uuid string 해당 ID를 조회한 경우 제공될 수 있습니다. ID 식별자입니다.
content.data[].creatorInfo.status integer 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 상태입니다.
content.data[].creatorInfo.wsAccountStatus integer 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 멤버 상태입니다.
content.data[].creatorInfo.username string 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 로그인 이름입니다.
content.data[].creatorInfo.name string 해당 ID를 조회한 경우 제공될 수 있습니다. 표시 이름입니다.
content.data[].creatorInfo.iconUrl string 해당 ID를 조회한 경우 제공될 수 있습니다. 프로필 이미지 URL입니다.
content.data[].creatorInfo.email string 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 이메일입니다. API Key ID의 경우 해당 식별자가 반환될 수 있습니다.
content.data[].creatorInfo.mobile string 해당 ID를 조회한 경우 제공될 수 있습니다. 연락처입니다.
content.data[].creatorInfo.countryCode string 해당 ID를 조회한 경우 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드입니다.
content.data[].creatorInfo.acntWsNickname string 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 내 닉네임입니다.
content.data[].updatorInfo.uuid string 해당 ID를 조회한 경우 제공될 수 있습니다. ID 식별자입니다.
content.data[].updatorInfo.status integer 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 상태입니다.
content.data[].updatorInfo.wsAccountStatus integer 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 멤버 상태입니다.
content.data[].updatorInfo.username string 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 로그인 이름입니다.
content.data[].updatorInfo.name string 해당 ID를 조회한 경우 제공될 수 있습니다. 표시 이름입니다.
content.data[].updatorInfo.iconUrl string 해당 ID를 조회한 경우 제공될 수 있습니다. 프로필 이미지 URL입니다.
content.data[].updatorInfo.email string 해당 ID를 조회한 경우 제공될 수 있습니다. 계정 이메일입니다. API Key ID의 경우 해당 식별자가 반환될 수 있습니다.
content.data[].updatorInfo.mobile string 해당 ID를 조회한 경우 제공될 수 있습니다. 연락처입니다.
content.data[].updatorInfo.countryCode string 해당 ID를 조회한 경우 제공될 수 있습니다. 휴대폰 번호 국가 또는 지역 코드입니다.
content.data[].updatorInfo.acntWsNickname string 해당 ID를 조회한 경우 제공될 수 있습니다. 워크스페이스 내 닉네임입니다.
content.data[].isFavourited boolean 호출 ID의 즐겨찾기 여부입니다.
content.declaration object 또는 null 워크스페이스의 공용 선언입니다.
{
  "code": 200,
  "content": {
    "data": [
      {
        "id": 11,
        "uuid": "note_example",
        "name": "生产巡检笔记",
        "workspaceUUID": "wksp_example",
        "isPublic": 1,
        "pos": [],
        "extend": {},
        "status": 0,
        "creator": "wsak_example",
        "updator": "",
        "createAt": 1785427200,
        "updateAt": -1,
        "deleteAt": -1,
        "creatorInfo": {},
        "updatorInfo": {},
        "isFavourited": false
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

인증, 속도 제한 및 공통 요청 오류는 공통 오류 정의를 참조하세요.

HTTP 상태 errorCode 발생 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 선언되지 않은 Query 파라미터를 사용했거나 파라미터가 규칙을 위반함 파라미터 파싱 실패 Query 파라미터 표와 예시를 확인합니다.

문서 평가

이 페이지가 도움이 되었나요?