문서 생성
POST
/crm-core/v1/documents
새로운 문서를 생성합니다. MEMBER 이상 권한이 필요합니다.
참고
문서 발행 방식(issueMethod)은 요청 파라미터에 따라 자동 결정됩니다: templateId와 recordId가 모두 있으면 RECORD_TEMPLATE, templateId만 있으면 TEMPLATE_ONLY, 그 외에는 DIRECT_INPUT으로 설정됩니다.
Body Params
| 이름 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
documentTypeId | String | - | 문서 유형 ID |
entityId | String | - | 개체 ID |
recordId | String | - | 연결할 레코드 ID |
templateId | String | - | 사용할 템플릿 ID |
linkedRecordIds | Array<string> | - | 연결 레코드 ID 목록 |
issueMethod | String | - | 발행 방식 (DIRECT_INPUT, TEMPLATE_ONLY, RECORD_TEMPLATE) |
name | String | - | 문서 이름 |
content | Object | - | 문서 내용 (TipTap JSON 형식) |
variableValues | Object | - | 변수 값 (키-값 쌍) |
Response
| 이름 | 타입 | 반드시 반환 | 설명 |
|---|---|---|---|
documentId | String | O | 문서 고유 아이디 |
accountId | String | O | 계정 고유 아이디 |
documentTypeId | String | - | 문서 유형 ID |
entityId | String | - | 개체 ID |
recordId | String | - | 레코드 ID |
templateId | String | - | 템플릿 ID |
linkedRecordIds | Array<string> | - | 연결 레코드 ID 목록 |
issueMethod | String | O | 발행 방식 |
name | String | O | 문서 이름 |
content | Object | - | 문서 내용 |
htmlContent | String | - | HTML 변환 내용 |
dataSnapshot | Object | - | 생성 시점의 변수 데이터 스냅샷 |
attachments | Array<object> | - | 첨부파일 목록 |
status | String | O | 문서 상태 (DRAFT, FINALIZED, ARCHIVED) |
issuedAt | Date | - | 발행 일시 |
issuedBy | String | - | 발행자 ID |
dateCreated | Date | O | 최초 생성 날짜 |
dateUpdated | Date | O | 최근 수정 날짜 |