Akan.js

bizDoc

문서 설명

BaseURL

Mode

For

Auth

APIs

GET

/bizDoc/bizDocInsightInOrg/:orgId

Slice Insight - 조직 내 문서

Description

bizDoc.signal.bizDocInsightInOrg.desc

Parameters

Arg Key	Type	Enum	Name	Description
orgId	ID!	-	조직 ID	조직의 ID

Response Type

Returns:

BizDocInsight!

Key	Cls	Field Name	Description	Enum
count	Int!	bizDoc.count	bizDoc.count.desc	-

Response Example

GET

/bizDoc/bizDocInsightInProject/:projectId

Slice Insight - 프로젝트 내 문서

Description

bizDoc.signal.bizDocInsightInProject.desc

Parameters

Arg Key	Type	Enum	Name	Description
projectId	ID!	-	프로젝트 ID	프로젝트의 ID

Response Type

Returns:

BizDocInsight!

Key	Cls	Field Name	Description	Enum
count	Int!	bizDoc.count	bizDoc.count.desc	-

Response Example

GET

/bizDoc/bizDocListInOrg/:orgId

Slice List - 조직 내 문서

Description

bizDoc.signal.bizDocListInOrg.desc

Parameters

Arg Key	Type	Enum	Name	Description
orgId	ID!	-	조직 ID	조직의 ID

Query

Arg Key	Type	Enum	Name	Description
skip	Int!	-	skip	skip
limit	Int!	-	limit	limit
sort	String!	-	sort	sort

Response Type

Returns:

[LightBizDoc]!

Key	Cls	Field Name	Description	Enum
id	ID!	아이디	유니크한 아이디값	-
createdAt	Date!	생성일	데이터 생성 시각	-
updatedAt	Date!	수정일	데이터 마지막 수정 시각	-
removedAt	Date	삭제일	데이터 삭제 시각	-
project	LightProject!	프로젝트	문서의 프로젝트	-
type	String!	타입	문서의 타입
title	String!	제목	문서의 제목	-
abstract	String!	설명	문서의 설명	-
createdBy	LightUser!	생성자	문서의 생성자	-
access	String!	접근 권한	문서의 접근 권한
status	String!	상태	문서의 상태

Response Example

[
  {
    "id": "1234567890abcdef12345678",
    "createdAt": "2026-05-30T19:50:19.120Z",
    "updatedAt": "2026-05-30T19:50:19.120Z",
    "removedAt": "2026-05-30T19:50:19.120Z",
    "project": {
      "id": "1234567890abcdef12345678",
      "createdAt": "2026-05-30T19:50:19.120Z",
      "updatedAt": "2026-05-30T19:50:19.120Z",
      "removedAt": "2026-05-30T19:50:19.120Z",
      "org": {
        "id": "1234567890abcdef12345678",
        "createdAt": "2026-05-30T19:50:19.120Z",
        "updatedAt": "2026-05-30T19:50:19.120Z",
        "removedAt": "2026-05-30T19:50:19.120Z",
        "name": "String",
        "logo": {
          "id": "1234567890abcdef12345678",
          "createdAt": "2026-05-30T19:50:19.120Z",
          "updatedAt": "2026-05-30T19:50:19.120Z",
          "removedAt": "2026-05-30T19:50:19.120Z",
          "filename": "String",
          "mimetype": "String",
          "encoding": "String",
          "imageSize": 0,
          "url": "String",
          "abstractData": "String",
          "size": 0,
          "origin": "String",
          "lastModifiedAt": "2026-05-30T19:50:19.120Z",
          "progress": 0,
          "status": "active"
        }
      },
      "code": "String",
      "name": "String",
      "abstract": "String",
      "contactEmails": "String",
      "contactPhones": "String",
      "portfolioInfos": {
        "lang": "ko",
        "title": "String",
        "desc": "String",
        "hoverTitle": "String",
        "hoverDesc": "String",
        "thumbnail": {
          "id": "1234567890abcdef12345678",
          "createdAt": "2026-05-30T19:50:19.120Z",
          "updatedAt": "2026-05-30T19:50:19.120Z",
          "removedAt": "2026-05-30T19:50:19.120Z",
          "filename": "String",
          "mimetype": "String",
          "encoding": "String",
          "imageSize": 0,
          "url": "String",
          "abstractData": "String",
          "size": 0,
          "origin": "String",
          "lastModifiedAt": "2026-05-30T19:50:19.120Z",
          "progress": 0,
          "status": "active"
        }
      },
      "dependencies": [
        "app"
      ],
      "bizCards": {
        "id": "1234567890abcdef12345678",
        "createdAt": "2026-05-30T19:50:19.120Z",
        "updatedAt": "2026-05-30T19:50:19.120Z",
        "removedAt": "2026-05-30T19:50:19.120Z",
        "name": "String",
        "auxName": "String",
        "companyName": "String",
        "auxCompanyName": "String",
        "department": "String",
        "position": "String",
        "email": "String",
        "phone": "String",
        "homepage": "String",
        "frontImage": {
          "id": "1234567890abcdef12345678",
          "createdAt": "2026-05-30T19:50:19.120Z",
          "updatedAt": "2026-05-30T19:50:19.120Z",
          "removedAt": "2026-05-30T19:50:19.120Z",
          "filename": "String",
          "mimetype": "String",
          "encoding": "String",
          "imageSize": 0,
          "url": "String",
          "abstractData": "String",
          "size": 0,
          "origin": "String",
          "lastModifiedAt": "2026-05-30T19:50:19.120Z",
          "progress": 0,
          "status": "active"
        },
        "status": "active"
      },
      "status": "active"
    },
    "type": "administrative",
    "title": "String",
    "abstract": "String",
    "createdBy": {
      "id": "1234567890abcdef12345678",
      "createdAt": "2026-05-30T19:50:19.120Z",
      "updatedAt": "2026-05-30T19:50:19.120Z",
      "removedAt": "2026-05-30T19:50:19.120Z",
      "image": {
        "id": "1234567890abcdef12345678",
        "createdAt": "2026-05-30T19:50:19.120Z",
        "updatedAt": "2026-05-30T19:50:19.120Z",
        "removedAt": "2026-05-30T19:50:19.120Z",
        "filename": "String",
        "mimetype": "String",
        "encoding": "String",
        "imageSize": 0,
        "url": "String",
        "abstractData": "String",
        "size": 0,
        "origin": "String",
        "lastModifiedAt": "2026-05-30T19:50:19.120Z",
        "progress": 0,
        "status": "active"
      },
      "nickname": "String",
      "playing": "String",
      "profileStatus": "active",
      "lastLoginAt": "2026-05-30T19:50:19.120Z",
      "status": "prepare",
      "roles": [
        "root"
      ]
    },
    "access": "public",
    "status": "active"
  }
]

GET

/bizDoc/bizDocListInProject/:projectId

Slice List - 프로젝트 내 문서

Description

bizDoc.signal.bizDocListInProject.desc

Parameters

Arg Key	Type	Enum	Name	Description
projectId	ID!	-	프로젝트 ID	프로젝트의 ID

Query

Arg Key	Type	Enum	Name	Description
skip	Int!	-	skip	skip
limit	Int!	-	limit	limit
sort	String!	-	sort	sort

Response Type

Returns:

[LightBizDoc]!

Key	Cls	Field Name	Description	Enum
id	ID!	아이디	유니크한 아이디값	-
createdAt	Date!	생성일	데이터 생성 시각	-
updatedAt	Date!	수정일	데이터 마지막 수정 시각	-
removedAt	Date	삭제일	데이터 삭제 시각	-
project	LightProject!	프로젝트	문서의 프로젝트	-
type	String!	타입	문서의 타입
title	String!	제목	문서의 제목	-
abstract	String!	설명	문서의 설명	-
createdBy	LightUser!	생성자	문서의 생성자	-
access	String!	접근 권한	문서의 접근 권한
status	String!	상태	문서의 상태

Response Example

POST

/bizDoc/setBizDocAccess

문서 접근 권한 설정

Description

문서의 접근 권한을 설정하는 API

Body

Arg Key	Type	Enum	Name	Description
bizDocId	ID!	-	문서 ID	문서의 ID
access	String!		접근 권한	문서의 접근 권한

Response Type

Returns:

BizDoc!

Key	Cls	Field Name	Description	Enum
id	ID!	아이디	유니크한 아이디값	-
createdAt	Date!	생성일	데이터 생성 시각	-
updatedAt	Date!	수정일	데이터 마지막 수정 시각	-
removedAt	Date	삭제일	데이터 삭제 시각	-
org	LightOrg!	조직	문서의 조직	-
project	LightProject!	프로젝트	문서의 프로젝트	-
type	String!	타입	문서의 타입
title	String!	제목	문서의 제목	-
abstract	String!	설명	문서의 설명	-
files	[File]!	파일	문서의 파일	-
content	Any!	내용	문서의 내용	-
contentFiles	[File]!	내용 파일	문서의 내용 파일	-
createdBy	LightUser!	생성자	문서의 생성자	-
access	String!	접근 권한	문서의 접근 권한
status	String!	상태	문서의 상태

Response Example

{
  "id": "1234567890abcdef12345678",
  "createdAt": "2026-05-30T19:50:19.120Z",
  "updatedAt": "2026-05-30T19:50:19.120Z",
  "removedAt": "2026-05-30T19:50:19.120Z",
  "org": {
    "id": "1234567890abcdef12345678",
    "createdAt": "2026-05-30T19:50:19.120Z",
    "updatedAt": "2026-05-30T19:50:19.120Z",
    "removedAt": "2026-05-30T19:50:19.120Z",
    "name": "String",
    "logo": {
      "id": "1234567890abcdef12345678",
      "createdAt": "2026-05-30T19:50:19.120Z",
      "updatedAt": "2026-05-30T19:50:19.120Z",
      "removedAt": "2026-05-30T19:50:19.120Z",
      "filename": "String",
      "mimetype": "String",
      "encoding": "String",
      "imageSize": 0,
      "url": "String",
      "abstractData": "String",
      "size": 0,
      "origin": "String",
      "lastModifiedAt": "2026-05-30T19:50:19.120Z",
      "progress": 0,
      "status": "active"
    }
  },
  "project": {
    "id": "1234567890abcdef12345678",
    "createdAt": "2026-05-30T19:50:19.120Z",
    "updatedAt": "2026-05-30T19:50:19.120Z",
    "removedAt": "2026-05-30T19:50:19.120Z",
    "org": {
      "id": "1234567890abcdef12345678",
      "createdAt": "2026-05-30T19:50:19.120Z",
      "updatedAt": "2026-05-30T19:50:19.120Z",
      "removedAt": "2026-05-30T19:50:19.120Z",
      "name": "String",
      "logo": {
        "id": "1234567890abcdef12345678",
        "createdAt": "2026-05-30T19:50:19.120Z",
        "updatedAt": "2026-05-30T19:50:19.120Z",
        "removedAt": "2026-05-30T19:50:19.120Z",
        "filename": "String",
        "mimetype": "String",
        "encoding": "String",
        "imageSize": 0,
        "url": "String",
        "abstractData": "String",
        "size": 0,
        "origin": "String",
        "lastModifiedAt": "2026-05-30T19:50:19.120Z",
        "progress": 0,
        "status": "active"
      }
    },
    "code": "String",
    "name": "String",
    "abstract": "String",
    "contactEmails": "String",
    "contactPhones": "String",
    "portfolioInfos": {
      "lang": "ko",
      "title": "String",
      "desc": "String",
      "hoverTitle": "String",
      "hoverDesc": "String",
      "thumbnail": {
        "id": "1234567890abcdef12345678",
        "createdAt": "2026-05-30T19:50:19.120Z",
        "updatedAt": "2026-05-30T19:50:19.120Z",
        "removedAt": "2026-05-30T19:50:19.120Z",
        "filename": "String",
        "mimetype": "String",
        "encoding": "String",
        "imageSize": 0,
        "url": "String",
        "abstractData": "String",
        "size": 0,
        "origin": "String",
        "lastModifiedAt": "2026-05-30T19:50:19.120Z",
        "progress": 0,
        "status": "active"
      }
    },
    "dependencies": [
      "app"
    ],
    "bizCards": {
      "id": "1234567890abcdef12345678",
      "createdAt": "2026-05-30T19:50:19.120Z",
      "updatedAt": "2026-05-30T19:50:19.120Z",
      "removedAt": "2026-05-30T19:50:19.120Z",
      "name": "String",
      "auxName": "String",
      "companyName": "String",
      "auxCompanyName": "String",
      "department": "String",
      "position": "String",
      "email": "String",
      "phone": "String",
      "homepage": "String",
      "frontImage": {
        "id": "1234567890abcdef12345678",
        "createdAt": "2026-05-30T19:50:19.120Z",
        "updatedAt": "2026-05-30T19:50:19.120Z",
        "removedAt": "2026-05-30T19:50:19.120Z",
        "filename": "String",
        "mimetype": "String",
        "encoding": "String",
        "imageSize": 0,
        "url": "String",
        "abstractData": "String",
        "size": 0,
        "origin": "String",
        "lastModifiedAt": "2026-05-30T19:50:19.120Z",
        "progress": 0,
        "status": "active"
      },
      "status": "active"
    },
    "status": "active"
  },
  "type": "administrative",
  "title": "String",
  "abstract": "String",
  "files": {
    "id": "1234567890abcdef12345678",
    "createdAt": "2026-05-30T19:50:19.120Z",
    "updatedAt": "2026-05-30T19:50:19.120Z",
    "removedAt": "2026-05-30T19:50:19.120Z",
    "filename": "String",
    "mimetype": "String",
    "encoding": "String",
    "imageSize": 0,
    "url": "String",
    "abstractData": "String",
    "size": 0,
    "origin": "String",
    "lastModifiedAt": "2026-05-30T19:50:19.120Z",
    "progress": 0,
    "status": "active"
  },
  "content": {},
  "contentFiles": {
    "id": "1234567890abcdef12345678",
    "createdAt": "2026-05-30T19:50:19.120Z",
    "updatedAt": "2026-05-30T19:50:19.120Z",
    "removedAt": "2026-05-30T19:50:19.120Z",
    "filename": "String",
    "mimetype": "String",
    "encoding": "String",
    "imageSize": 0,
    "url": "String",
    "abstractData": "String",
    "size": 0,
    "origin": "String",
    "lastModifiedAt": "2026-05-30T19:50:19.120Z",
    "progress": 0,
    "status": "active"
  },
  "createdBy": {
    "id": "1234567890abcdef12345678",
    "createdAt": "2026-05-30T19:50:19.120Z",
    "updatedAt": "2026-05-30T19:50:19.120Z",
    "removedAt": "2026-05-30T19:50:19.120Z",
    "image": {
      "id": "1234567890abcdef12345678",
      "createdAt": "2026-05-30T19:50:19.120Z",
      "updatedAt": "2026-05-30T19:50:19.120Z",
      "removedAt": "2026-05-30T19:50:19.120Z",
      "filename": "String",
      "mimetype": "String",
      "encoding": "String",
      "imageSize": 0,
      "url": "String",
      "abstractData": "String",
      "size": 0,
      "origin": "String",
      "lastModifiedAt": "2026-05-30T19:50:19.120Z",
      "progress": 0,
      "status": "active"
    },
    "nickname": "String",
    "playing": "String",
    "profileStatus": "active",
    "lastLoginAt": "2026-05-30T19:50:19.120Z",
    "status": "prepare",
    "roles": [
      "root"
    ]
  },
  "access": "public",
  "status": "active"
}

Web Socket

bizDoc

문서 설명

BaseURL

Mode

For

Auth

APIs

GET

/bizDoc/bizDocInsightInOrg/:orgId

Slice Insight - 조직 내 문서

Description

bizDoc.signal.bizDocInsightInOrg.desc

Parameters

Arg Key	Type	Enum	Name	Description
orgId	ID!	-	조직 ID	조직의 ID

Response Type

Returns:

BizDocInsight!

Key	Cls	Field Name	Description	Enum
count	Int!	bizDoc.count	bizDoc.count.desc	-

Response Example

GET

/bizDoc/bizDocInsightInProject/:projectId

Slice Insight - 프로젝트 내 문서

Description

bizDoc.signal.bizDocInsightInProject.desc

Parameters

Arg Key	Type	Enum	Name	Description
projectId	ID!	-	프로젝트 ID	프로젝트의 ID

Response Type

Returns:

BizDocInsight!

Key	Cls	Field Name	Description	Enum
count	Int!	bizDoc.count	bizDoc.count.desc	-

Response Example

GET

/bizDoc/bizDocListInOrg/:orgId

Slice List - 조직 내 문서

Description

bizDoc.signal.bizDocListInOrg.desc

Parameters

Arg Key	Type	Enum	Name	Description
orgId	ID!	-	조직 ID	조직의 ID

Query

Arg Key	Type	Enum	Name	Description
skip	Int!	-	skip	skip
limit	Int!	-	limit	limit
sort	String!	-	sort	sort

Response Type

Returns:

[LightBizDoc]!

Key	Cls	Field Name	Description	Enum
id	ID!	아이디	유니크한 아이디값	-
createdAt	Date!	생성일	데이터 생성 시각	-
updatedAt	Date!	수정일	데이터 마지막 수정 시각	-
removedAt	Date	삭제일	데이터 삭제 시각	-
project	LightProject!	프로젝트	문서의 프로젝트	-
type	String!	타입	문서의 타입
title	String!	제목	문서의 제목	-
abstract	String!	설명	문서의 설명	-
createdBy	LightUser!	생성자	문서의 생성자	-
access	String!	접근 권한	문서의 접근 권한
status	String!	상태	문서의 상태

Response Example

GET

/bizDoc/bizDocListInProject/:projectId

Slice List - 프로젝트 내 문서

Description

bizDoc.signal.bizDocListInProject.desc

Parameters

Arg Key	Type	Enum	Name	Description
projectId	ID!	-	프로젝트 ID	프로젝트의 ID

Query

Arg Key	Type	Enum	Name	Description
skip	Int!	-	skip	skip
limit	Int!	-	limit	limit
sort	String!	-	sort	sort

Response Type

Returns:

[LightBizDoc]!

Key	Cls	Field Name	Description	Enum
id	ID!	아이디	유니크한 아이디값	-
createdAt	Date!	생성일	데이터 생성 시각	-
updatedAt	Date!	수정일	데이터 마지막 수정 시각	-
removedAt	Date	삭제일	데이터 삭제 시각	-
project	LightProject!	프로젝트	문서의 프로젝트	-
type	String!	타입	문서의 타입
title	String!	제목	문서의 제목	-
abstract	String!	설명	문서의 설명	-
createdBy	LightUser!	생성자	문서의 생성자	-
access	String!	접근 권한	문서의 접근 권한
status	String!	상태	문서의 상태

Response Example

POST

/bizDoc/setBizDocAccess

문서 접근 권한 설정

Description

문서의 접근 권한을 설정하는 API

Body

Arg Key	Type	Enum	Name	Description
bizDocId	ID!	-	문서 ID	문서의 ID
access	String!		접근 권한	문서의 접근 권한

Response Type

Returns:

BizDoc!

Key	Cls	Field Name	Description	Enum
id	ID!	아이디	유니크한 아이디값	-
createdAt	Date!	생성일	데이터 생성 시각	-
updatedAt	Date!	수정일	데이터 마지막 수정 시각	-
removedAt	Date	삭제일	데이터 삭제 시각	-
org	LightOrg!	조직	문서의 조직	-
project	LightProject!	프로젝트	문서의 프로젝트	-
type	String!	타입	문서의 타입
title	String!	제목	문서의 제목	-
abstract	String!	설명	문서의 설명	-
files	[File]!	파일	문서의 파일	-
content	Any!	내용	문서의 내용	-
contentFiles	[File]!	내용 파일	문서의 내용 파일	-
createdBy	LightUser!	생성자	문서의 생성자	-
access	String!	접근 권한	문서의 접근 권한
status	String!	상태	문서의 상태

Response Example

Web Socket