콘텐츠로 이동

생성



POST /api/v1/notes/create

개요

레거시 노트를 생성하고 노트 UUID를 반환합니다.

호출 전 준비 및 사용 단계

최소 요청에는 이름만 있으면 됩니다. 응답의 content.uuid에서 새 노트 UUID를 얻은 뒤 노트 가져오기를 호출하여 차트를 재구성할 수 있습니다. chartUUIDs는 순서 참조를 저장합니다. 차트 내용을 실제로 노트에 가져오려면 템플릿 가져오기를 사용합니다.

요청 헤더

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

Body 요청 파라미터

파라미터명 타입 필수 설명
name string Y 노트 이름이며 최대 128자입니다.
null 허용: False
최대 길이: 128
예: 生产巡检笔记
가져오기 또는 입력 방법: 새 노트 이름을 입력하거나 기존 노트 이름을 재사용합니다.
chartUUIDs array 차트 UUID의 순서 배열이며 최대 32개입니다. 생략하면 비어 있습니다. 여기에는 참조만 저장되며 기존 차트의 소유권을 다시 설정하지 않습니다.
null 허용: False
최대 길이: 32
예: []
가져오기 또는 입력 방법: 새 노트는 빈 배열로 둘 수 있습니다. 기존 차트의 UUID는 해당 레거시 노트 상세의 content.charts[].uuid에서 확인할 수 있습니다.
extend json 노트 확장 설정이며 생략하면 {}입니다.
null 허용: False
예: {}
가져오기 또는 입력 방법: 노트 상세의 content.extend 또는 템플릿의 extend에서 기존 설정을 복사하는 것을 우선합니다.

파라미터 추가 설명

기본적으로 이름만으로 빈 노트를 생성할 수 있습니다. 레거시 노트 템플릿에서 가져와야 하는 경우 먼저 새 노트의 UUID를 저장합니다.

요청 예시

curl --request POST 'https://openapi.guance.com/api/v1/notes/create' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"生产巡检笔记"}'

응답

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

필드 타입 설명
content.id integer 노트 레코드 번호입니다.
content.uuid string 노트 UUID이며 조회, 수정, 가져오기, 삭제에 사용됩니다.
content.name string 노트 이름입니다.
content.workspaceUUID string 소속 워크스페이스입니다.
content.isPublic integer 공개 범위이며 1은 공개, 0은 생성한 ID에만 공개입니다.
content.extend object 노트 확장 설정입니다.
content.status integer 노트의 현재 상태입니다.
content.creator string 생성자 ID입니다.
content.updator string 최근 업데이트한 사용자 ID이며, 업데이트가 없으면 비어 있을 수 있습니다.
content.createAt number 생성 시간이며 Unix 초 단위입니다.
content.updateAt number 최근 업데이트 시간이며 Unix 초 단위입니다. 업데이트가 없으면 -1일 수 있습니다.
content.deleteAt number 삭제 시간이며 Unix 초 단위입니다. 삭제되지 않았으면 -1입니다.
content.pos array<object> 차트의 순서 참조 배열입니다.
content.pos[].chartUUID string 차트 UUID입니다.
content.declaration object 또는 null 워크스페이스의 공용 선언입니다.
{
  "code": 200,
  "content": {
    "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,
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

오류 응답

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

HTTP 상태 errorCode 트리거 조건 메시지 또는 응답 설명 처리 방법
406 ft.ParameterValidationFailed 요청 필드가 누락되었거나 필드 값이 선언된 검증 조건을 위반함 파라미터 파싱 실패 파라미터 위치, 필드명, 타입, 값을 확인합니다.
400 ft.RequestJsonFormatError 요청 JSON 구문이 유효하지 않음 요청 JSON 형식 오류 content.reason, line, column에 따라 JSON을 수정합니다.
400 ft.JsonFormatError JSON 구문은 유효하지만 요청 최상위가 객체가 아님 일부 json 파일 형식 오류 파라미터를 JSON 객체에 넣은 후 다시 시도합니다.
403 ft.ForbiddenFreeEditionLimit 워크스페이스에 해당 쿼터가 설정되어 있고 레거시 노트 수가 상한에 도달함 무료 플랜 워크스페이스 {}가 상한({}개)에 도달하여 새로 생성할 수 없습니다. 상용 플랜을 개통하면 제한이 해제됩니다 워크스페이스 버전 및 노트 수를 확인한 후 쿼터 또는 리소스를 조정합니다.

문서 평가

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