수정¶
POST /api/v1/notes/{notes_uuid}/modify
개요¶
레거시 노트의 이름과 지정된 구성을 업데이트합니다.
호출 전 및 사용 단계¶
먼저 노트 상세로 대상과 현재 이름을 확인합니다. 요청에는 여전히 name을 포함해야 하며, 기존 값을 그대로 전달할 수 있습니다. chartUUIDs를 생략하면 기존 참조가 유지되고, 전체 배열을 전달하면 순서가 교체되며 제외된 기존 차트는 소프트 삭제됩니다. []를 전달하면 모든 기존 참조가 제거됩니다. 차트를 다시 생성해야 하는 경우 가져오기 API를 사용합니다. 전송 전에 먼저 백업을 내보냅니다.
경로 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| notes_uuid | string | Y | 대상 레거시 노트의 UUID입니다. 예시: note_example가져오기 또는 입력 방법: 노트 목록의 content.data[].uuid에서 가져오거나, 생성 응답의 content.uuid를 사용할 수도 있습니다. |
요청 헤더¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| DF-API-KEY | string | Y | 워크스페이스의 OpenAPI 인증 자격 증명입니다. 예시: <DF-API-KEY>가져오기 또는 입력 방법: 대상 워크스페이스의 API Key 관리에서 해당 작업 권한이 있는 OpenAPI Key를 가져옵니다. |
Body 요청 파라미터¶
| 파라미터 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
| name | string | Y | 필수이며, 업데이트된 노트 이름으로 최대 128자입니다. null 허용: False 최대 길이: 128 예시: 生产巡检笔记 v2가져오기 또는 입력 방법: 이름을 변경하지 않는 경우 노트 상세에서 content.name을 가져와 그대로 제출합니다. |
| chartUUIDs | array | 최대 총 32개입니다. 차트 참조를 수정해야 할 때만 전달합니다. null 허용: False 최대 길이: 32 예시: ["chrt_example"]가져오기 또는 입력 방법: 대상 노트의 노트 상세에서 content.charts[].uuid를 가져와 원하는 순서대로 전체 목록을 제출합니다. |
|
| extend | json | 제출 시 확장 객체를 전체 교체하며, 생략하면 기존 값이 유지됩니다. null 허용: False 예시: {}가져오기 또는 입력 방법: 노트 상세의 content.extend 또는 템플릿의 extend에서 기존 구성을 복사하는 것을 우선합니다. |
파라미터 추가 설명¶
업데이트 응답은 이전 이름 oldName을 반환합니다. 현재 차트 목록을 확인하려면 노트 상세를 계속 조회합니다.
요청 예시¶
curl --request POST 'https://openapi.guance.com/api/v1/notes/note_example/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"name":"生产巡检笔记 v2"}'
응답¶
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.oldName | string | 수정 전 이름입니다. |
| content.declaration | object 또는 null | 워크스페이스의 공통 선언입니다. |
{
"code": 200,
"content": {
"id": 11,
"uuid": "note_example",
"name": "生产巡检笔记 v2",
"workspaceUUID": "wksp_example",
"isPublic": 1,
"extend": {},
"status": 0,
"creator": "wsak_example",
"updator": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427320,
"deleteAt": -1,
"oldName": "生产巡检笔记",
"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 객체에 넣은 후 다시 시도합니다. |
| 404 | ft.NotFoundNote | UUID가 삭제되었거나 존재하지 않거나 현재 API Key의 워크스페이스에 없습니다 | 지정된 노트를 찾을 수 없습니다 | 동일한 워크스페이스의 노트 목록으로 UUID를 확인합니다. |