M5
기능
Doc

Doc이란?

Doc 은 데이터 구조에서 저장소 역할을 합니다.
자식으로도 Doc 이 될수도 있으므로, 부모가 Bucket Doc 인 구조가 가능합니다.

Bucket 에서 지정한 도메인의 데이터를 표현하는 개념으로 사용되고,
Bucket 보다는 더 자세히 데이터를 표현하기 위해 세부 속성들이 제공됩니다.

M5 Doc 데이터 구조

SVCDoc

데이터 형식
type필수string

분류 값 입니다. 도메인의 세부사항을 분류할때 활용됩니다. Doc을 fetch 요청시 type 값으로 filter하여 조회할 수 있습니다.

published필수boolean자세히

데이터의 공개여부를 결정합니다. 비공개 데이터는 해당 유저만 조회 할 수 있습니다. · 공개: true(default) · 비공개: false

title필수string

제목 값 입니다. Doc 데이터의 명칭으로 활용됩니다.

subtitle선택string

title에서 또 다른 명칭이 필요할때 활용됩니다.

key선택string

id선택string

고유 ID 값 입니다. 생성할 때는 필요하지 않으며, 업데이트 요청의 경우 필수 값 입니다.

bucketId선택string

Doc의 Bucket ID입니다. fetch 요청 시 BucketId를 활용하여 해당 Bucket에 속한 Doc만 조회할 수 있습니다.

parentId선택string

Doc의 부모가 되는 고유값입니다. Doc의 데이터 구조에서 부모로는 Bucket, Doc이 될 수 있습니다. fetch 요청시에는 { fetchParents: true } 옵션을 사용하여 부모의 정보도 함께 조회할 수 있습니다.

user선택string: SVCUser####

유저의 고유 값 입니다. 일반적으로는 Doc을 생성한 유저의 ID가 저장됩니다.

userId선택string: SVCUser####

유저의 고유 값 입니다. 일반적으로는 Doc을 생성한 유저의 ID가 저장됩니다.

code선택string자세히

고유한 값으로 데이터를 업데이트하거나 생성하는 기준입니다. checkCodeMode를 통해 등록된 code 값이 존재하는지 여부를 확인하여 업데이트 또는 생성을 수행합니다.

orgCode선택string

User의 orgCode(Organization Code)를 지정 할 수 있습니다. 해당 데이터는 orgCode에 해당되는 유저만 조회 할 수 있습니다.

subtype선택string

type에서 또 다른 분류가 필요할때 활용됩니다.

status선택string

데이터의 상태 값 입니다.

substatus선택string

status에서 또 다른 상태 값이 필요할때 활용됩니다.

content선택string

콘텐츠(내용) 값 입니다.

files선택File자세히

필요한 파일들을 저장합니다.

dates선택Object

날짜 정보들을 Object 형식으로 저장합니다. { start: number(Unix Timestamp), end: number(Unix Timestamp) } 와 같이 활용할 수 있습니다.

created선택number(Unix Timestamp)

생성된 시간 입니다.

updated선택number(Unix Timestamp)

업데이트 반영된 시간 입니다.

deleted선택boolean

데이터의 영구삭제를 결정합니다. 영구삭제 되지 않은 데이터는 데이터베이스에 보존 됩니다. · 삭제: true · 삭제안함: false

userData선택unknown

원하는 형식의 데이터를 저장할 수 있습니다. 위 Property에서 표현할 수 없는 데이터를 저장할 수 있습니다. 주로 데이터의 세부 내용을 저장하게 되며, 사전에 반드시 데이터 설계가 필요합니다.